com.marklogic.client.expression.SqlExpr Maven / Gradle / Ivy
Show all versions of marklogic-client-api Show documentation
/*
* Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
*/
package com.marklogic.client.expression;
import com.marklogic.client.type.XsAnyAtomicTypeSeqVal;
import com.marklogic.client.type.XsAnyAtomicTypeVal;
import com.marklogic.client.type.XsBooleanVal;
import com.marklogic.client.type.XsDecimalVal;
import com.marklogic.client.type.XsIntegerVal;
import com.marklogic.client.type.XsIntVal;
import com.marklogic.client.type.XsStringVal;
import com.marklogic.client.type.XsUnsignedIntVal;
import com.marklogic.client.type.XsUnsignedLongVal;
import com.marklogic.client.type.ServerExpression;
// IMPORTANT: Do not edit. This file is generated.
/**
* Builds expressions to call functions in the sql server library for a row
* pipeline.
*/
public interface SqlExpr {
/**
* Returns the length of the string "str" in bits.
*
*
*
* Provides a client interface to the sql:bit-length server function.
* @param str The string to be evaluated. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression bitLength(ServerExpression str);
/**
* Returns an unsignedLong specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the greater index.
*
* Provides a client interface to the sql:bucket server function.
* @param bucketEdgesParam A sequence of ordered values indicating the edges of a collection of buckets. If the sequence is out of order or has duplicates, SQL-UNORDERED is thrown. (of xs:anyAtomicType)
* @param srchParam A value to find an index for in the bucket edge list. (of xs:anyAtomicType)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression bucket(ServerExpression bucketEdgesParam, String srchParam);
/**
* Returns an unsignedLong specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the greater index.
*
*
*
* Provides a client interface to the sql:bucket server function.
* @param bucketEdgesParam A sequence of ordered values indicating the edges of a collection of buckets. If the sequence is out of order or has duplicates, SQL-UNORDERED is thrown. (of xs:anyAtomicType)
* @param srchParam A value to find an index for in the bucket edge list. (of xs:anyAtomicType)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression bucket(ServerExpression bucketEdgesParam, ServerExpression srchParam);
/**
* Returns an unsignedLong specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the greater index.
*
* Provides a client interface to the sql:bucket server function.
* @param bucketEdgesParam A sequence of ordered values indicating the edges of a collection of buckets. If the sequence is out of order or has duplicates, SQL-UNORDERED is thrown. (of xs:anyAtomicType)
* @param srchParam A value to find an index for in the bucket edge list. (of xs:anyAtomicType)
* @param collationLiteral A collation identifier. All bucketEdgesParam and srcParam are converted to a string of this collation if supplied. (of xs:string)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression bucket(ServerExpression bucketEdgesParam, String srchParam, String collationLiteral);
/**
* Returns an unsignedLong specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the greater index.
*
* Provides a client interface to the sql:bucket server function.
* @param bucketEdgesParam A sequence of ordered values indicating the edges of a collection of buckets. If the sequence is out of order or has duplicates, SQL-UNORDERED is thrown. (of xs:anyAtomicType)
* @param srchParam A value to find an index for in the bucket edge list. (of xs:anyAtomicType)
* @param collationLiteral A collation identifier. All bucketEdgesParam and srcParam are converted to a string of this collation if supplied. (of xs:string)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression bucket(ServerExpression bucketEdgesParam, ServerExpression srchParam, ServerExpression collationLiteral);
/**
* Returns an rdf:collatedString value with the given value and collation tag. The rdf:collatedString type extends xs:string , and represents a collation tagged string in RDF.
*
* Provides a client interface to the sql:collated-string server function.
* @param string The lexical value. (of xs:string)
* @param collationURI The collation URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression collatedString(ServerExpression string, String collationURI);
/**
* Returns an rdf:collatedString value with the given value and collation tag. The rdf:collatedString type extends xs:string , and represents a collation tagged string in RDF.
*
*
*
* Provides a client interface to the sql:collated-string server function.
* @param string The lexical value. (of xs:string)
* @param collationURI The collation URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression collatedString(ServerExpression string, ServerExpression collationURI);
/**
* Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
*
* Provides a client interface to the sql:dateadd server function.
* @param 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)
* @param number This number will be added to the datepart of the given date. (of xs:int)
* @param 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)
* @return a server expression with the item server data type
*/
public ServerExpression 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
*
*
*
* Provides a client interface to the sql:dateadd server function.
* @param 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)
* @param number This number will be added to the datepart of the given date. (of xs:int)
* @param 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)
* @return a server expression with the item server data type
*/
public ServerExpression dateadd(ServerExpression datepart, ServerExpression number, ServerExpression date);
/**
* Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.
*
*
*
* Provides a client interface to the sql:datediff server function.
* @param 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)
* @param 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)
* @param enddate Same as startdate. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression datediff(ServerExpression datepart, ServerExpression startdate, ServerExpression enddate);
/**
* Returns an integer that represents the specified datepart of the specified date.
*
*
*
* Provides a client interface to the sql:datepart server function.
* @param 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)
* @param 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)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression datepart(ServerExpression datepart, ServerExpression date);
/**
* Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
*
*
*
* Provides a client interface to the sql:day server function.
* @param arg The xs:genericDateTimeArg whose day component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression day(ServerExpression arg);
/**
* Returns an xs:string representing the dayname value in the localized value of arg.
*
*
*
* Provides a client interface to the sql:dayname server function.
* @param arg The date whose dayname value will be returned. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression dayname(ServerExpression arg);
/**
* Returns true if the specified input glob the specified pattern, otherwise returns false.
*
* Provides a client interface to the sql:glob server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '?' matches one character and '*' matches any number of characters. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression glob(ServerExpression input, String pattern);
/**
* Returns true if the specified input glob the specified pattern, otherwise returns false.
*
*
*
* Provides a client interface to the sql:glob server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '?' matches one character and '*' matches any number of characters. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression glob(ServerExpression input, ServerExpression pattern);
/**
* Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of arg.
*
*
*
* Provides a client interface to the sql:hours server function.
* @param arg The genericDateTime whose hours component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression hours(ServerExpression arg);
/**
* If the first expression is NULL, then the value of the second expression is returned. If not null, the first expression is returned.
*
*
*
* Provides a client interface to the sql:ifnull server function.
* @param expr1 First expression to be evaluated. (of item)
* @param expr2 Second expression to be evaluated. (of item)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression ifnull(ServerExpression expr1, ServerExpression expr2);
/**
* 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.
*
* Provides a client interface to the sql:insert server function.
* @param str The string to manipulate. (of xs:string)
* @param start The starting position where characters will be inserted. (of xs:numeric)
* @param length The number of characters to be removed. (of xs:numeric)
* @param str2 The string to insert. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression insert(ServerExpression str, double start, double length, 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.
*
*
*
* Provides a client interface to the sql:insert server function.
* @param str The string to manipulate. (of xs:string)
* @param start The starting position where characters will be inserted. (of xs:numeric)
* @param length The number of characters to be removed. (of xs:numeric)
* @param str2 The string to insert. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression insert(ServerExpression str, ServerExpression start, ServerExpression length, ServerExpression str2);
/**
* Find the starting location of a pattern in a string.
*
* Provides a client interface to the sql:instr server function.
* @param str The string to be evaluated. (of xs:string)
* @param n The pattern to be evaluated. (of xs:string)
* @return a server expression with the xs:unsignedInt server data type
*/
public ServerExpression instr(ServerExpression str, String n);
/**
* Find the starting location of a pattern in a string.
*
*
*
* Provides a client interface to the sql:instr server function.
* @param str The string to be evaluated. (of xs:string)
* @param n The pattern to be evaluated. (of xs:string)
* @return a server expression with the xs:unsignedInt server data type
*/
public ServerExpression instr(ServerExpression str, ServerExpression n);
/**
* Returns a string that is the leftmost characters of the target string. The number of characters to return is specified by the second argument.
*
* Provides a client interface to the sql:left server function.
* @param str The base string. If the value is not a string, its string value will be used. (of xs:anyAtomicType)
* @param n The number of leftmost characters of the string to return. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression left(ServerExpression str, double n);
/**
* Returns a string that is the leftmost characters of the target string. The number of characters to return is specified by the second argument.
*
*
*
* Provides a client interface to the sql:left server function.
* @param str The base string. If the value is not a string, its string value will be used. (of xs:anyAtomicType)
* @param n The number of leftmost characters of the string to return. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression left(ServerExpression str, ServerExpression n);
/**
* Returns true if the specified input like the specified pattern, otherwise returns false.
*
* Provides a client interface to the sql:like server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '_' matches one character and '%' matches any number of characters. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression like(ServerExpression input, String pattern);
/**
* Returns true if the specified input like the specified pattern, otherwise returns false.
*
*
*
* Provides a client interface to the sql:like server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '_' matches one character and '%' matches any number of characters. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression like(ServerExpression input, ServerExpression pattern);
/**
* Returns true if the specified input like the specified pattern, otherwise returns false.
*
* Provides a client interface to the sql:like server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '_' matches one character and '%' matches any number of characters. (of xs:string)
* @param escape If a '_' or '%' are preceeded by an escape character then it will be match as the char '_'/'%' themselves. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression like(ServerExpression input, String pattern, String escape);
/**
* Returns true if the specified input like the specified pattern, otherwise returns false.
*
* Provides a client interface to the sql:like server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The expression to match. '_' matches one character and '%' matches any number of characters. (of xs:string)
* @param escape If a '_' or '%' are preceeded by an escape character then it will be match as the char '_'/'%' themselves. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression like(ServerExpression input, ServerExpression pattern, ServerExpression escape);
/**
* Return a string that removes leading empty spaces in the input string.
*
*
*
* Provides a client interface to the sql:ltrim server function.
* @param str The string to be evaluated. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression ltrim(ServerExpression str);
/**
* Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
*
*
*
* Provides a client interface to the sql:minutes server function.
* @param arg The genericDateTime whose minutes component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression minutes(ServerExpression arg);
/**
* Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
*
*
*
* Provides a client interface to the sql:month server function.
* @param arg The genericDateTime whose month component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression month(ServerExpression arg);
/**
* Returns month name, calculated from the localized value of arg.
*
*
*
* Provides a client interface to the sql:monthname server function.
* @param arg The date whose month-name will be returned. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression monthname(ServerExpression arg);
/**
* Returns a NULL value if the two specified values are equal. Returns the first value if they are not equal
*
*
*
* Provides a client interface to the sql:nullif server function.
* @param expr1 First expression to be evaluated. (of item)
* @param expr2 Second expression to be evaluated. (of item)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression nullif(ServerExpression expr1, ServerExpression expr2);
/**
* Returns the length of the string "str" in bits.
*
*
*
* Provides a client interface to the sql:octet-length server function.
* @param x The string to be evaluated. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression octetLength(ServerExpression x);
/**
* Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
*
*
*
* Provides a client interface to the sql:quarter server function.
* @param arg The genericDateTime whose quarter component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression quarter(ServerExpression arg);
/**
* Return a random number. This differs from xdmp:random in that the argument is a seed.
*
*
*
* Provides a client interface to the sql:rand server function.
* @param n The random seed. Currently this parameter is ignored. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression rand(ServerExpression n);
/**
* Returns a string that concatenates the first argument as many times as specified by the second argument.
*
* Provides a client interface to the sql:repeat server function.
* @param str The string to duplicate. If the value is not a string, its string value will be used. (of item)
* @param n The number of times to repeat the string. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression repeat(ServerExpression str, double n);
/**
* Returns a string that concatenates the first argument as many times as specified by the second argument.
*
*
*
* Provides a client interface to the sql:repeat server function.
* @param str The string to duplicate. If the value is not a string, its string value will be used. (of item)
* @param n The number of times to repeat the string. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression repeat(ServerExpression str, ServerExpression n);
/**
* Returns a string that is the rightmost characters of the target string. The number of characters to return is specified by the second argument.
*
* Provides a client interface to the sql:right server function.
* @param str The base string. If the value is not a string, its string value will be used. (of xs:anyAtomicType)
* @param n The number of rightmost characters of the string to return. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression right(ServerExpression str, double n);
/**
* Returns a string that is the rightmost characters of the target string. The number of characters to return is specified by the second argument.
*
*
*
* Provides a client interface to the sql:right server function.
* @param str The base string. If the value is not a string, its string value will be used. (of xs:anyAtomicType)
* @param n The number of rightmost characters of the string to return. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression right(ServerExpression str, ServerExpression n);
/**
* Constructs a row identifier from the string form of the temporary identifier assigned to a row during processing.
*
*
* @param arg1 the arg1 value. (of xs:anyAtomicType)
* @return a server expression with the sql:rowID server data type
*/
public ServerExpression rowID(ServerExpression arg1);
/**
* Return a string that removes trailing empty spaces in the input string.
*
*
*
* Provides a client interface to the sql:rtrim server function.
* @param str The string to be evaluated. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression rtrim(ServerExpression str);
/**
* Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of arg. Note that the value can be greater than 60 seconds to accommodate occasional leap seconds used to keep human time synchronized with the rotation of the planet.
*
*
*
* Provides a client interface to the sql:seconds server function.
* @param arg The time whose seconds component will be returned. (of item)
* @return a server expression with the xs:decimal server data type
*/
public ServerExpression seconds(ServerExpression arg);
/**
* Returns the sign of number x.
*
*
*
* Provides a client interface to the sql:sign server function.
* @param x The number to be evaluated. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression sign(ServerExpression x);
/**
* Returns a four-character (SOUNDEX) code to evaluate the similarity of two strings.
*
*
*
* Provides a client interface to the sql:soundex server function.
* @param arg The string whose soundex will be returned. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression soundex(ServerExpression arg);
/**
* Returns a string that is the given number of spaces.
*
*
*
* Provides a client interface to the sql:space server function.
* @param n The number of spaces to return as a string. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression space(ServerExpression n);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the sql:strpos server function.
* @param target The string from which to test. (of xs:string)
* @param test The string to test for existence in the second parameter. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression strpos(ServerExpression target, String test);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
*
*
* Provides a client interface to the sql:strpos server function.
* @param target The string from which to test. (of xs:string)
* @param test The string to test for existence in the second parameter. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression strpos(ServerExpression target, ServerExpression test);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the sql:strpos server function.
* @param target The string from which to test. (of xs:string)
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression strpos(ServerExpression target, String test, String collation);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the sql:strpos server function.
* @param target The string from which to test. (of xs:string)
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression strpos(ServerExpression target, ServerExpression test, ServerExpression collation);
/**
* Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
*
* Provides a client interface to the sql:timestampadd server function.
* @param 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)
* @param value The integer to add to the given dateTimeType field of the third parameter. (of xs:int)
* @param timestamp The xs:dateTime timestamp to which addition has to take place. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression 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.
*
*
*
* Provides a client interface to the sql:timestampadd server function.
* @param 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)
* @param value The integer to add to the given dateTimeType field of the third parameter. (of xs:int)
* @param timestamp The xs:dateTime timestamp to which addition has to take place. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression timestampadd(ServerExpression dateTimeType, ServerExpression value, ServerExpression timestamp);
/**
* Returns the difference in dateTimeType field of two given timestamps.
*
*
*
* Provides a client interface to the sql:timestampdiff server function.
* @param 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)
* @param timestamp1 The integer to add to the given dateTimeType field of the third parameter. (of item)
* @param timestamp2 The xs:dateTime timestamp to which addition has to take place. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression timestampdiff(ServerExpression dateTimeType, ServerExpression timestamp1, ServerExpression timestamp2);
/**
* Return a string that removes leading and trailing empty spaces in the input string.
*
*
*
* Provides a client interface to the sql:trim server function.
* @param str The string to be evaluated. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression trim(ServerExpression str);
/**
* Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
*
*
*
* Provides a client interface to the sql:week server function.
* @param arg The dateTime/date/string whose day component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression week(ServerExpression arg);
/**
* Returns the day of the week.
*
*
* @param arg1 the arg1 value. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression weekday(ServerExpression arg1);
/**
* Returns an xs:integer representing the year component in the localized value of arg. The result may be negative.
*
*
*
* Provides a client interface to the sql:year server function.
* @param arg The dateTime/date/string whose day component will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression year(ServerExpression arg);
/**
* Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
*
*
*
* Provides a client interface to the sql:yearday server function.
* @param arg The xs:genericDateTimeArg whose days of the year will be returned. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression yearday(ServerExpression arg);
}