public interface SqlExpr
Modifier and Type | Method and Description |
---|---|
XsIntegerExpr |
bitLength(ServerExpression str)
Returns the length of the string "str" in bits.
|
XsStringExpr |
collatedString(ServerExpression string,
ServerExpression collationURI)
Returns an rdf:collatedString value with the given value and collation tag.
|
XsStringExpr |
collatedString(ServerExpression string,
java.lang.String collationURI)
Returns an rdf:collatedString value with the given value and collation tag.
|
ItemExpr |
dateadd(ServerExpression datepart,
int number,
ServerExpression date)
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
|
ItemExpr |
dateadd(ServerExpression datepart,
ServerExpression number,
ServerExpression date)
|
XsIntegerExpr |
datediff(ServerExpression datepart,
ServerExpression startdate,
ServerExpression enddate)
Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.
|
XsIntegerExpr |
datepart(ServerExpression datepart,
ServerExpression date)
Returns an integer that represents the specified datepart of the specified date.
|
XsIntegerExpr |
day(ServerExpression arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsStringExpr |
dayname(ServerExpression arg)
Returns an xs:string representing the dayname value in the localized value of arg.
|
XsIntegerExpr |
hours(ServerExpression arg)
Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of arg.
|
XsStringExpr |
insert(ServerExpression str,
double start,
double length,
java.lang.String str2)
Returns a string that that is the first argument with length characters removed starting at start and the second string has been inserted beginning at start.
|
XsStringExpr |
insert(ServerExpression str,
ServerExpression start,
ServerExpression length,
ServerExpression str2)
Returns a string that that is the first argument with length characters removed starting at start and the second string has been inserted beginning at start.
|
XsUnsignedIntExpr |
instr(ServerExpression str,
ServerExpression n)
Find the starting location of a pattern in a string.
|
XsUnsignedIntExpr |
instr(ServerExpression str,
java.lang.String n)
Find the starting location of a pattern in a string.
|
XsStringExpr |
left(ServerExpression str,
double n)
Returns a string that is the leftmost characters of the target string.
|
XsStringExpr |
left(ServerExpression str,
ServerExpression n)
Returns a string that is the leftmost characters of the target string.
|
XsStringExpr |
ltrim(ServerExpression str)
Return a string that removes leading empty spaces in the input string.
|
XsIntegerExpr |
minutes(ServerExpression arg)
Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
|
XsIntegerExpr |
month(ServerExpression arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsStringExpr |
monthname(ServerExpression arg)
Returns month name, calculated from the localized value of arg.
|
XsIntegerExpr |
octetLength(ServerExpression x)
Returns the length of the string "str" in bits.
|
XsIntegerExpr |
quarter(ServerExpression arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsUnsignedLongExpr |
rand(ServerExpression n)
Return a random number.
|
XsStringExpr |
repeat(ServerExpression str,
double n)
Returns a string that concatenates the first argument as many times as specified by the second argument.
|
XsStringExpr |
repeat(ServerExpression str,
ServerExpression n)
Returns a string that concatenates the first argument as many times as specified by the second argument.
|
XsStringExpr |
right(ServerExpression str,
double n)
Returns a string that is the rightmost characters of the target string.
|
XsStringExpr |
right(ServerExpression str,
ServerExpression n)
Returns a string that is the rightmost characters of the target string.
|
XsStringExpr |
rtrim(ServerExpression str)
Return a string that removes trailing empty spaces in the input string.
|
XsDecimalExpr |
seconds(ServerExpression arg)
Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of arg.
|
ItemSeqExpr |
sign(ServerExpression x)
Returns the sign of number x.
|
XsStringExpr |
space(ServerExpression n)
Returns a string that is the given number of spaces.
|
ItemExpr |
timestampadd(ServerExpression dateTimeType,
int value,
ServerExpression timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
ItemExpr |
timestampadd(ServerExpression dateTimeType,
ServerExpression value,
ServerExpression timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
XsIntegerExpr |
timestampdiff(ServerExpression dateTimeType,
ServerExpression timestamp1,
ServerExpression timestamp2)
Returns the difference in dateTimeType field of two given timestamps.
|
XsStringExpr |
trim(ServerExpression str)
Return a string that removes leading empty spaces in the input string.
|
XsIntegerExpr |
week(ServerExpression arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsIntegerExpr |
weekday(ServerExpression arg1) |
XsIntegerExpr |
year(ServerExpression arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
yearday(ServerExpression arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsIntegerExpr bitLength(ServerExpression str)
Provides a client interface to the sql:bit-length server function.
str
- The string to be evaluated. (of xs:string)XsStringExpr collatedString(ServerExpression string, java.lang.String collationURI)
Provides a client interface to the sql:collated-string server function.
XsStringExpr collatedString(ServerExpression string, ServerExpression collationURI)
Provides a client interface to the sql:collated-string server function.
ItemExpr dateadd(ServerExpression datepart, int number, ServerExpression date)
Provides a client interface to the sql:dateadd server function.
datepart
- Is the part of date where the number will be added. The following table lists all valid datepart arguments. User-defined variable equivalents are not valid. The return data type is the data type of the date argument. Options: datepart parameter abbreviation includes: "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date (of xs:string)number
- This number will be added to the datepart of the given date. (of xs:int)date
- Is an expression that can be resolved to a time, date or datetime, value. date can be an expression, column expression, user-defined variable or string literal. startdate is subtracted from enddate. (of item)ItemExpr dateadd(ServerExpression datepart, ServerExpression number, ServerExpression date)
Provides a client interface to the sql:dateadd server function.
datepart
- Is the part of date where the number will be added. The following table lists all valid datepart arguments. User-defined variable equivalents are not valid. The return data type is the data type of the date argument. Options: datepart parameter abbreviation includes: "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date (of xs:string)number
- This number will be added to the datepart of the given date. (of xs:int)date
- Is an expression that can be resolved to a time, date or datetime, value. date can be an expression, column expression, user-defined variable or string literal. startdate is subtracted from enddate. (of item)XsIntegerExpr datediff(ServerExpression datepart, ServerExpression startdate, ServerExpression enddate)
Provides a client interface to the sql:datediff server function.
datepart
- Is the part of startdate and enddate that specifies the type of boundary crossed. The following table lists all valid datepart arguments. User-defined variable equivalents are not valid. Options: datepart parameter abbreviation includes: "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date (of xs:string)startdate
- Is an expression that can be resolved to a time, date, datetime or value. date can be an expression, column expression, user-defined variable or string literal. startdate is subtracted from enddate. (of item)enddate
- Same as startdate. (of item)XsIntegerExpr datepart(ServerExpression datepart, ServerExpression date)
Provides a client interface to the sql:datepart server function.
datepart
- The part of date that to be returned. Options: datepart parameter abbreviation includes: "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date "TZoffset","tz" The timezone offset from the date (of xs:string)date
- Is an expression that can be resolved to a xs:date, xs:time, xs:dateTime. date can be an expression, column expression,user-defined variable, or string literal. (of item)XsIntegerExpr day(ServerExpression arg)
Provides a client interface to the sql:day server function.
arg
- The xs:genericDateTimeArg whose day component will be returned. (of item)XsStringExpr dayname(ServerExpression arg)
Provides a client interface to the sql:dayname server function.
XsIntegerExpr hours(ServerExpression arg)
Provides a client interface to the sql:hours server function.
arg
- The genericDateTime whose hours component will be returned. (of item)XsStringExpr insert(ServerExpression str, double start, double length, java.lang.String str2)
Provides a client interface to the sql:insert server function.
str
- The string to manipulate. (of xs:string)start
- The starting position where characters will be inserted. (of xs:numeric)length
- The number of characters to be removed. (of xs:numeric)str2
- The string to insert. (of xs:string)XsStringExpr insert(ServerExpression str, ServerExpression start, ServerExpression length, ServerExpression str2)
Provides a client interface to the sql:insert server function.
str
- The string to manipulate. (of xs:string)start
- The starting position where characters will be inserted. (of xs:numeric)length
- The number of characters to be removed. (of xs:numeric)str2
- The string to insert. (of xs:string)XsUnsignedIntExpr instr(ServerExpression str, java.lang.String n)
Provides a client interface to the sql:instr server function.
str
- The string to be evaluated. (of xs:string)n
- The pattern to be evaluated. (of xs:string)XsUnsignedIntExpr instr(ServerExpression str, ServerExpression n)
Provides a client interface to the sql:instr server function.
str
- The string to be evaluated. (of xs:string)n
- The pattern to be evaluated. (of xs:string)XsStringExpr left(ServerExpression str, double n)
Provides a client interface to the sql:left server function.
str
- The base string. If the value is not a string, its string value will be used. (of item)n
- The number of leftmost characters of the string to return. (of xs:numeric)XsStringExpr left(ServerExpression str, ServerExpression n)
Provides a client interface to the sql:left server function.
str
- The base string. If the value is not a string, its string value will be used. (of item)n
- The number of leftmost characters of the string to return. (of xs:numeric)XsStringExpr ltrim(ServerExpression str)
Provides a client interface to the sql:ltrim server function.
XsIntegerExpr minutes(ServerExpression arg)
Provides a client interface to the sql:minutes server function.
arg
- The genericDateTime whose minutes component will be returned. (of item)XsIntegerExpr month(ServerExpression arg)
Provides a client interface to the sql:month server function.
arg
- The genericDateTime whose month component will be returned. (of item)XsStringExpr monthname(ServerExpression arg)
Provides a client interface to the sql:monthname server function.
XsIntegerExpr octetLength(ServerExpression x)
Provides a client interface to the sql:octet-length server function.
x
- The string to be evaluated. (of xs:string)XsIntegerExpr quarter(ServerExpression arg)
Provides a client interface to the sql:quarter server function.
arg
- The genericDateTime whose quarter component will be returned. (of item)XsUnsignedLongExpr rand(ServerExpression n)
Provides a client interface to the sql:rand server function.
n
- The random seed. Currently this parameter is ignored. (of xs:unsignedLong)XsStringExpr repeat(ServerExpression str, double n)
Provides a client interface to the sql:repeat server function.
str
- The string to duplicate. If the value is not a string, its string value will be used. (of item)n
- The number of times to repeat the string. (of xs:numeric)XsStringExpr repeat(ServerExpression str, ServerExpression n)
Provides a client interface to the sql:repeat server function.
str
- The string to duplicate. If the value is not a string, its string value will be used. (of item)n
- The number of times to repeat the string. (of xs:numeric)XsStringExpr right(ServerExpression str, double n)
Provides a client interface to the sql:right server function.
str
- The base string. If the value is not a string, its string value will be used. (of item)n
- The number of rightmost characters of the string to return. (of xs:numeric)XsStringExpr right(ServerExpression str, ServerExpression n)
Provides a client interface to the sql:right server function.
str
- The base string. If the value is not a string, its string value will be used. (of item)n
- The number of rightmost characters of the string to return. (of xs:numeric)XsStringExpr rtrim(ServerExpression str)
Provides a client interface to the sql:rtrim server function.
XsDecimalExpr seconds(ServerExpression arg)
Provides a client interface to the sql:seconds server function.
arg
- The time whose seconds component will be returned. (of item)ItemSeqExpr sign(ServerExpression x)
Provides a client interface to the sql:sign server function.
x
- The number to be evaluated. (of xs:numeric)XsStringExpr space(ServerExpression n)
Provides a client interface to the sql:space server function.
n
- The number of spaces to return as a string. (of xs:numeric)ItemExpr timestampadd(ServerExpression dateTimeType, int value, ServerExpression timestamp)
Provides a client interface to the sql:timestampadd server function.
dateTimeType
- The dateTimeType of the timestamp where addition should take place. Available types are: SQL_TSI_FRAC_SECOND nano seconds SQL_TSI_SECOND seconds SQL_TSI_MINUTE minute SQL_TSI_HOUR hour SQL_TSI_DAY day SQL_TSI_WEEK week SQL_TSI_MONTH month SQL_TSI_QUARTER quarter SQL_TSI_YEAR year (of xs:string)value
- The integer to add to the given dateTimeType field of the third parameter. (of xs:int)timestamp
- The xs:dateTime timestamp to which addition has to take place. (of item)ItemExpr timestampadd(ServerExpression dateTimeType, ServerExpression value, ServerExpression timestamp)
Provides a client interface to the sql:timestampadd server function.
dateTimeType
- The dateTimeType of the timestamp where addition should take place. Available types are: SQL_TSI_FRAC_SECOND nano seconds SQL_TSI_SECOND seconds SQL_TSI_MINUTE minute SQL_TSI_HOUR hour SQL_TSI_DAY day SQL_TSI_WEEK week SQL_TSI_MONTH month SQL_TSI_QUARTER quarter SQL_TSI_YEAR year (of xs:string)value
- The integer to add to the given dateTimeType field of the third parameter. (of xs:int)timestamp
- The xs:dateTime timestamp to which addition has to take place. (of item)XsIntegerExpr timestampdiff(ServerExpression dateTimeType, ServerExpression timestamp1, ServerExpression timestamp2)
Provides a client interface to the sql:timestampdiff server function.
dateTimeType
- The dateTimeType of the timestamp where addition should take place. Available types are: SQL_TSI_FRAC_SECOND nano seconds SQL_TSI_SECOND seconds SQL_TSI_MINUTE minute SQL_TSI_HOUR hour SQL_TSI_DAY day SQL_TSI_WEEK week SQL_TSI_MONTH month SQL_TSI_QUARTER quarter SQL_TSI_YEAR year (of xs:string)timestamp1
- The integer to add to the given dateTimeType field of the third parameter. (of item)timestamp2
- The xs:dateTime timestamp to which addition has to take place. (of item)XsStringExpr trim(ServerExpression str)
Provides a client interface to the sql:trim server function.
XsIntegerExpr week(ServerExpression arg)
Provides a client interface to the sql:week server function.
arg
- The dateTime/date/string whose day component will be returned. (of item)XsIntegerExpr weekday(ServerExpression arg1)
XsIntegerExpr year(ServerExpression arg)
Provides a client interface to the sql:year server function.
arg
- The dateTime/date/string whose day component will be returned. (of item)XsIntegerExpr yearday(ServerExpression arg)
Provides a client interface to the sql:yearday server function.
arg
- The xs:genericDateTimeArg whose days of the year will be returned. (of item)Copyright © 2013-2018 MarkLogic Corporation.