http://docs.openlinksw.com/virtuoso/functions.html Virtuoso Functions Guide OpenLink Virtuoso Universal Server: Documentation virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com 2008-11-25T00:17:53Z OpenLink Software Documentation Team http://docs.openlinksw.com/virtuoso/../images/misc/logo.jpg http://docs.openlinksw.com/virtuoso/fn_var.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: VAR Returns the variance.VAR (VARIANCE) returns variance of expr. Virtuoso calculates the variance of expr as follows: 0 if the number of rows in expr = 1; VAR_SAMP if the number of rows in expr > 1 http://docs.openlinksw.com/virtuoso/fn_var_samp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: VAR_SAMP Returns the sample variance.VAR_SAMP returns the sample variance of a set of numbers after discarding the nulls in this set. The expr is a numeric expression, and the function returns a value of type NUMERIC. If the function is applied to an empty set, then it returns null. The function makes the following calculation: This function is similar to VAR, except that given an input set of one element, VAR returns 0 and VAR_SAMP returns null. http://docs.openlinksw.com/virtuoso/fn_var_pop.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: VAR_POP Returns the population variance.VAR_POP returns the population variance of a set of numbers after discarding the nulls in this set. The expr is a number expression, and the function returns a value of type NUMERIC. If the function is applied to an empty set, then it returns null. The function makes the following calculation: http://docs.openlinksw.com/virtuoso/fn_stddev.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: STDDEV Returns the standard deviation.STDDEV returns standard deviation. it returns STDDEV_SAMP if the number of pairs is more than one, or NULL. http://docs.openlinksw.com/virtuoso/fn_stddev_samp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: STDDEV_SAMP Returns the cumulative sample standard deviation.STDDEV_SAMP computes the cumulative sample standard deviation and returns the square root of the sample variance. The expr is a numeric expression, and the function returns a value of type NUMERIC. This function is same as the square root of the VAR_SAMP function. When VAR_SAMP returns null, this function returns null. http://docs.openlinksw.com/virtuoso/fn_stddev_pop.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: STDDEV_POP Returns the population standard deviation.STDDEV_POP computes the population standard deviation and returns the square root of the population variance. This function is the same as the square root of the VAR_POP function. When VAR_POP returns null, this function returns null. http://docs.openlinksw.com/virtuoso/fn_regr_syy.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_SYY Auxiliary function used to compute various diagnostic statistics.REGR_SYY makes the following computation after eliminating NULL (expr1, expr2) pairs: http://docs.openlinksw.com/virtuoso/fn_regr_sxx.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_SXX Auxiliary function used to compute various diagnostic statistics.REGR_SXX makes the following computation after eliminating NULL (expr1, expr2) pairs: http://docs.openlinksw.com/virtuoso/fn_regr_sxy.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_SXY Auxiliary function used to compute various diagnostic statistics.REGR_SXY makes the following computation after eliminating NULL (expr1, expr2) pairs: http://docs.openlinksw.com/virtuoso/fn_regr_avgx.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_AVGX Evaluates the average of the independent variable (expr2) of the regression line.REGR_AVGX evaluates the average of the independent variable (expr2) of the regression line. It makes the following computation after the elimination of null (expr1, expr2) pairs: http://docs.openlinksw.com/virtuoso/fn_regr_avgy.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_AVGY Evaluates the average of the independent variable (expr1) of the regression line.REGR_AVGY evaluates the average of the independent variable (expr1) of the regression line. It makes the following computation after the elimination of null (expr1, expr2) pairs: http://docs.openlinksw.com/virtuoso/fn_regr_r2.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_R2 Returns the coefficient of determination (R-squared) of the regression line.REGR_R2 returns the coefficient of determination (also called "R-squared" or "goodness of fit") for the regression. VAR_POP(expr1) and VAR_POP(expr2) are evaluated after the elimination of null pairs. The return values are: http://docs.openlinksw.com/virtuoso/fn_regr_count.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_COUNT Returns the number of non-null numbers used to fit the regression line.REGR_COUNT Returns the number of non-null numbers used to fit the regression line. http://docs.openlinksw.com/virtuoso/fn_regr_intercept.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_INTERCEPT Returns the y-intercept of the regression line.REGR_INTERCEPT returns the y-intercept of the regression line. After the elimination of null (expr1, expr2) pairs, it makes the following computation: http://docs.openlinksw.com/virtuoso/fn_regr_slope.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: REGR_SLOPE Returns the slope of the line.REGR_SLOPE returns the slope of the line. After the elimination of null (expr1, expr2) pairs, it makes the following computation: http://docs.openlinksw.com/virtuoso/fn_covar_samp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: COVAR_SAMP Returns the sample covariance of a set of number pairs.COVAR_SAMP returns the sample covariance of a set of number pairs. Both expr1 and expr2 are numeric expressions. Virtuoso applies the function to the set of (expr1, expr2) pairs after eliminating all pairs for which either expr1 or expr2 is null. Then Virtuoso makes the following computation: where n is the number of (expr1, expr2) pairs where neither expr1 nor expr2 is null. http://docs.openlinksw.com/virtuoso/fn_covar_pop.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: COVAR_POP Returns the population covariance of a set of number pairs.COVAR_POP returns the population covariance of a set of number pairs. Both expr1 and expr2 are numeric expressions. Virtuoso applies the function to the set of (expr1, expr2) pairs after eliminating all pairs for which either expr1 or expr2 is null. Then Virtuoso makes the following computation: where n is the number of (expr1, expr2) pairs where neither expr1 nor expr2 is null. http://docs.openlinksw.com/virtuoso/fn_corr.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Aggregate Functions 2008-11-25T00:17:53Z Function: CORR Returns the coefficient of correlation of a set of number pairs.CORR returns the coefficient of correlation of a set of number pairs. Both expr1 and expr2 are number expressions. Virtuoso applies the function to the set of (expr1, expr2) after eliminating the pairs for which either expr1 or expr2 is null. Then Virtuoso makes the following computation: http://docs.openlinksw.com/virtuoso/fn_abs.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: abs Return the absolute value of a numberabs returns the absolute value of its argument. http://docs.openlinksw.com/virtuoso/fn___any_grants.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: __any_grants Checks a table for grants.The __any_grants() can be used to test whether there are any rights granted (for insert/update/delete) to a table for current SQL account. http://docs.openlinksw.com/virtuoso/fn_aref.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: aref returns specific element of an array or stringaref returns the nth element of an array, string or string_session, where nth is a zero-based index. If the first argument is a string or string_session, the integer ASCII value of the nth character is returned. If the first argument is an array of any, then the corresponding element is returned. http://docs.openlinksw.com/virtuoso/fn_ascii.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com String 2008-11-25T00:17:53Z Function: ascii Get ASCII value of a characterascii returns the ASCII value of the first character of a string. If an empty string is given, then zero is returned. http://docs.openlinksw.com/virtuoso/fn_aset.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: aset set array elementaset sets the nth element of a string, array or vector where nth is a zero-based index. If the first argument is a string, the nth character of string is replaced with the ASCII value given in the third argument elem. http://docs.openlinksw.com/virtuoso/fn_atof.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: atof Convert a string to single precision floatatof returns its argument as a single precision floating point. If the string cannot be parsed and converted to a valid float, a value 0.0 is returned. http://docs.openlinksw.com/virtuoso/fn_atoi.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com String 2008-11-25T00:17:53Z Function: atoi Convert a string to an integeratoi returns its argument as an integer. If the string cannot be parsed and converted to a valid integer, a value 0 is returned. http://docs.openlinksw.com/virtuoso/fn_att_local_name.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Remote SQL Data Source 2008-11-25T00:17:53Z Function: att_local_name Compose a fully qualified table name based on DSN and remote table name.The utility function, att_local_name(), can be used to make a fully qualified table name from non-qualified or qualified one, i.e. the qualifier and owner will be added if they are missing. The schema name will be replaced with current qualifier on execution, owner will be replaced or added with name of supplied DSN name. All non-alphanumeric characters in the name will be replaced with underscore symbol. http://docs.openlinksw.com/virtuoso/fn_backup.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Backup 2008-11-25T00:17:53Z Function: backup Write data into transaction log format for backup purposes. Deprecated. This function requires dba privileges. http://docs.openlinksw.com/virtuoso/fn_backup_online.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Backup 2008-11-25T00:17:53Z Function: backup_online perform online backup of databaseThis procedure will backup all information from the checkpoint space to a series of files named "<file_prefix><n>.bp", where <n> is the sequence number of the file in the backup series. The first backup will be a full gzip compressed dump of database pages in the checkpoint space. Any subsequent call will only backup pages which have changed since the last backup was made. To start with a fresh full backup, use backup_clear_context to clear the change tracking data. At each checkpoint the checkpoint space will be updated, and the next "backup_online;" procedure will create new files. Once backup_online() has been called for the first time, the arguments supplied will be used for subsequent calls to it. Hence, arguments supplied to this procedure (except the "dirs" argument) will be ignored in subsequent calls. Before a new backup series can be started, the backup_context_clear(); procedure must be called first. This procedure will clear the current backup context and mark all pages in the checkpoint space as ready for backup. A database checkpoint cannnot be performed while an online backup is in progress. Attempt to do a checkpoint will wait until the backup is complete. http://docs.openlinksw.com/virtuoso/fn_backup_context_clear.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Backup 2008-11-25T00:17:53Z Function: backup_context_clear Clears the backup context and marks all pages in checkpoint space as ready for online backupThis procedure must be called before a new backup series can be started, This procedure will clear the current backup context and mark all pages in the checkpoint space as ready for backup. http://docs.openlinksw.com/virtuoso/fn_bif_arg.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Virtuoso Server Extension Interface (VSEI) 2008-11-25T00:17:53Z Function: Virtuoso Server Extension Interface (VSEI) functions Get parameters for built in functionThe bif_...._arg functions are used in the Virtuoso shared object. They allow customization of the Virtuoso server. They are written in C code, and linked with the Virtuoso shared object. The _or_null_ variants of these functions represent the SQL null value as a 00 pointer, even though getting the same argument with bif_arg() would return a box with the DV_DB_NULL tag. All number functions will coerce other types of numbers to the result type. All array argument functions will accept any type of array. It is up to the VSE itself to distinguish. Virtuoso Server Extensions (VSEs) were formally referred to as Built-In Functions (BIFs). http://docs.openlinksw.com/virtuoso/fn_bit_and.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: bit_and Returns bitwise AND of two 32-bit integers.The function returns bitwise AND of two given integers. On 64-bit platforms, both arguments are intentionally truncated to 32 bits to maintain compatibility. http://docs.openlinksw.com/virtuoso/fn_bit_or.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: bit_or Returns bitwise OR of two 32-bit integers.The function returns bitwise OR of two given integers. On 64-bit platforms, both arguments are intentionally truncated to 32 bits to maintain compatibility. http://docs.openlinksw.com/virtuoso/fn_bit_not.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: bit_not Returns bitwise NOT of a 32-bit integer.The function returns bitwise NOT of a given integer. On 64-bit platforms the argument is intentionally truncated to 32 bits to maintain compatibility. http://docs.openlinksw.com/virtuoso/fn_bit_shift.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: bit_shift Returns the result of bitwise shift operation over two 32-bit integers.The function returns bitwise shift of two given integers. Depending on the arguments, the shift may be left or right. For right-shift, leftmost bits of the result are filled by the value of the 31-st bit. On 64-bit platforms, both arguments are intentionally truncated to 32 bits and the shift is restricted to 32 bits to maintain compatibility. http://docs.openlinksw.com/virtuoso/fn_bit_xor.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: bit_xor Returns bitwise XOR (exclusive "or") of two 32-bit integers.The function returns bitwise XOR (exclusive "or") of two given integers. On 64-bit platforms, both arguments are intentionally truncated to 32 bits, to provide compartibility. http://docs.openlinksw.com/virtuoso/fn_blob_to_string.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com String 2008-11-25T00:17:53Z Function: blob_to_string Convert a blob to stringAlthough primarily used for converting blobs (long varbinary, long varchar) to string, blob_to_string may also be used to convert from wide string, persistent XML (XPER) and string_output streams. If the data being converted is longer than maximum length of a string, blob_to_string will signal an error. http://docs.openlinksw.com/virtuoso/fn_blob_to_string_output.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com String 2008-11-25T00:17:53Z Function: blob_to_string_output Convert a blob to string sessionAlthough primarily used for converting blobs (long varbinary, long varchar) to string output object, blob_to_string_output may also be used to convert from wide string, persistent XML (XPER) and string_output streams. http://docs.openlinksw.com/virtuoso/fn_bookmark.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Cursor 2008-11-25T00:17:53Z Function: bookmark Return the bookmark for current row of a scrollable cursorbookmark returns a bookmark for the current row of an open scrollable cursor. Given an invalid argument, i.e. no cursor, no current row or non-open cursor, it signals an error. The returned value can be used in subsequent FETCH .. BOOKMARK over the same cursor. http://docs.openlinksw.com/virtuoso/fn_ceiling.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: ceiling Round a number to positive infinity.ceiling calculates the smallest integer greater than or equal to x. http://docs.openlinksw.com/virtuoso/fn_cfg_item_count.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_item_count return number of items in a section in configuration fileReturn the number of items that exist in the specified section of the INI file. http://docs.openlinksw.com/virtuoso/fn_cfg_item_name.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_item_name get nth item name from ini fileReturns the name of the item specified by item_index (begins from zero). If the index and section name do not point to a valid item, then zero is returned, otherwise on success the function returns the item name. http://docs.openlinksw.com/virtuoso/fn_cfg_item_value.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_item_value returns the value of an item from the ini fileReturn the value of an item identified by item_name and section parameters from the specified INI file. http://docs.openlinksw.com/virtuoso/fn_cfg_section_count.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_section_count get number of sections in an INI fileReturns the number of sections in an INI file. http://docs.openlinksw.com/virtuoso/fn_cfg_section_name.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_section_name returns INI file section nameReturns the name of section specified by the index (begins from zero). If the index can reference a section, the that section name is returned, otherwise returns zero on error. http://docs.openlinksw.com/virtuoso/fn_cfg_write.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: cfg_write Writes the item=value to an INI fileThis function requires dba privileges. This function allows modification of existing entries, or update updating existing items in an INI file. http://docs.openlinksw.com/virtuoso/fn_charset_define.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: charset_define Define a character set.This function creates a new narrow language-specific character set, or redefines an existing one. http://docs.openlinksw.com/virtuoso/fn_charset_recode.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: charset_recode Translate a string to another character setThis function translates a string from a given source charset to a destination charset. It provides a generic way of recoding string entities. The src_charset may be a narrow or a wide string. If it's a narrow string (VARCHAR) then the src_charset is taken into account and defines the current encoding of the src_string. In any other case src_charset is ignored. src_charset and dst_charset are names of system-defined 8 bit charset tables. Use charsets_list to obtain a list of currently defined character sets and aliases. If either of these is null, then the charset in effect is used. There are two special character set names - "UTF-8" and "_WIDE_" - that are recognized by this function. These represent UTF-8 encoding of characters and wide string (NVARCHAR). http://docs.openlinksw.com/virtuoso/fn_charsets_list.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: charsets_list List known character set names and aliases.This function produces a list of all character set names and aliases known to Virtuoso. The returned value is an array of strings with a character set name as each element. If the gen_res_set flag is 1, the function also produces a result set in which each row contains one varchar column with a name of a character set or alias. http://docs.openlinksw.com/virtuoso/fn_checkpoint_interval.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: checkpoint_interval Configure database checkpointingThis function changes the database checkpointing interval to the given value in minutes. It may also be used to disable checkpointing in two ways: By setting checkpoint interval to 0, the checkpoint will only be performed after roll forward upon database startup. A setting of -1 will disable all checkpointing. Main use for this function is to ensure a clean online backup of the database slices. Copying of the database may take long and checkpointing would modify those files in mid-copy, thus rendering the resulting copy unusable. In case the system should, for some reason or another, become unstable, it is sometimes better to disable checkpointing after a database restart to resume backing up from where it was left prior to a system crash. Disabling all checkpointing by giving checkpoint_interval the value of -1 will do just that. The interval setting will be saved in the server configuration file as value of CheckpointInterval in section [Parameters], thus it will persist over consecutive server shutdown/restart cycles. A long checkpoint_interval setting will produce longer transaction logs, which in turn prolongs the time it takes for the database to perform a roll forward upon restart in case it was shut down without making a checkpoint. http://docs.openlinksw.com/virtuoso/fn_chr.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com String 2008-11-25T00:17:53Z Function: chr Convert a long character code to a character or wide characterchr returns a new one character long string containing the character with character code given as parameter. http://docs.openlinksw.com/virtuoso/fn_client_attr.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: client_attr returns a varchar containing the requested information from the connection http://docs.openlinksw.com/virtuoso/fn_collation_define.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: collation_define define a new collationThis function lets you define a new collation. http://docs.openlinksw.com/virtuoso/fn_complete_table_name.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: complete_table_name Returns a fully qualified table name.The complete_table_name() can be used to make a fully qualified table name from non-qualified one, i.e. the qualifier and owner will be added if they are missing. http://docs.openlinksw.com/virtuoso/fn_composite.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Free Text 2008-11-25T00:17:53Z Function: composite create a composite objectCreate a composite object Returns a composite object containing the serialization of each argument. The total serialized length of the arguments may not exceed 255. http://docs.openlinksw.com/virtuoso/fn_composite_ref.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Free Text 2008-11-25T00:17:53Z Function: composite_ref get member of a composite objectcomposite_ref returns the nth element of the composite. The index is 0 based. http://docs.openlinksw.com/virtuoso/fn_concat.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: concat Concatenate stringsconcat returns a new string, concatenated from a variable number of strings given as arguments. NULL arguments are handled as empty strings. concat (str) returns a copy of str. concat () returns an empty string. http://docs.openlinksw.com/virtuoso/fn_concatenate.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: concatenate concatenate stringsConcatenate is an alias of concat. http://docs.openlinksw.com/virtuoso/fn_connection_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_get Get connection variableconnection_get is used to retrieve values stored within the current connection context. See connection_set for a more detailed discussion of connection variables. http://docs.openlinksw.com/virtuoso/fn_connection_id.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_id get connection identifierThis function returns a string uniquely identifying the connection in this server instance. It is usually a combination of server's port number and a serial number of the client. http://docs.openlinksw.com/virtuoso/fn_connection_is_dirty.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_is_dirty check if current session connection variables have been alteredThis function is used to determine if the session variables have changed between a call to connection_vars_set and current point of execution. A call to connection_vars_set will cause subsequent calls to connection_is_dirty to return true. The function is useful in postprocessing functions for making conditional storage of session variables in a database table. http://docs.openlinksw.com/virtuoso/fn_connection_set.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_set Associates a value to the name in the context of the present connectionThis associates a value to the name in the context of present connection. The name should be a string and the value can be any data type except blob, open cursor or an XML entity. If the value is an array it may not contain the restricted types. Connection variable setting is not logged and information stored will be lost when the connection is closed. The value can be retrieved by any future statement executing within the same connection. Connection variables can be used as a global variable mechanism for stored procedures, the scope being the client connection. In the case of VSP or SOAP this mechanism cannot be used to pass information between requests by the same client. It will however, be useful for having 'global variables' between procedures called within the same HTTP request. Note that this mechanism is used to provide persistent HTTP session variables in some cases but this works through special before and after code which stores the values set with this function into an external session structure. In this sense this function itself has nothing to do with web session management although it can be used as a component for such. http://docs.openlinksw.com/virtuoso/fn_connection_vars.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_vars Retrieve all connection variables This function returns all stored session variables in an array with name/value pairs. Connection variables do not persist across sessions, one may maintain persistence of variables by storing them in a database table: see the Session Variables Section. http://docs.openlinksw.com/virtuoso/fn_connection_vars_set.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: connection_vars_set set all connection variablesThis function clears all connection variables for current session and sets new ones defined in the array passed as parameter. Connection variables do not persist across sessions, one may maintain persistence of variables by storing them in a database table, as discussed in Session Variables -section. http://docs.openlinksw.com/virtuoso/fn_contains.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Free Text 2008-11-25T00:17:53Z Function: contains A text contains predicate This is a SQL predicate that specifies a condition on a column on which a free text index exists. The expression is a string matching the grammar of a text search expression. This is computed for each evaluation of the contains predicate and does not have to be a constant. For example a parameter or variable of a containing score (e.g. procedure) is accepted. The score_limit is optional. If specified, it should be a numeric expression determining the minimum score required to produce a hit. A virtual column named 'SCORE' is available in queries involving a contains predicate. This can for example be returned in a result set or used for sorting. Note that the name is in upper case and is case sensitive in all case modes. http://docs.openlinksw.com/virtuoso/fn_cov_load.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: cov_load Load test coverage data from file.This function accepts one argument with name of file containing test coverage data. The expected format of the file is described in the Branch Coverage section. The loaded file is merged with the data already collected by Virtuoso. More than one file can be loaded. The ultimate report will be the union of all files. http://docs.openlinksw.com/virtuoso/fn_cov_report.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: cov_report Produce a text coverage report.This function is used to produce a coverage report in text format. The format of the file is described in the Branch Coverage section. This function takes a filename 'fname' as a path to the extended coverage report file and 'outdir' as a path to a directory where .cov files will be stored. The profile.prof file in the output directory is a summary of function call counts and execution times, once ranked by self time, once by time spent inside the function and functions called from there. Note that directory must exists before calling this function. http://docs.openlinksw.com/virtuoso/fn_cov_store.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: cov_store Writes a test coverage to a file.This function is used to produce a coverage file called fname. The expected format of the file is described in the Branch Coverage section. By default a normal concise coverage will be produced. If the add_comment parameter is set to 1 then the coverage will include code excerpts contained in line entities. http://docs.openlinksw.com/virtuoso/fn_createXML.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com XML 2008-11-25T00:17:53Z Function: createXML This function creates an XMLType instance. It works absolutely identically to the XMLType() constructor and is provided solely for compatibility. http://docs.openlinksw.com/virtuoso/fn_curdate.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: curdate get current date and timeThese functions return the current date or time as a date, time or datetime, respectively. Internally they all return the same value but data type reported to client differs. http://docs.openlinksw.com/virtuoso/fn_current_charset.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: current_charset Get name of current charset.This function returns the "preferred" name of the current charset as a string. It returns value which is set in the INI file or those which is set with 'SET CHARSET=..' call. This cannot be used to return charset for the current HTTP connection in the VSP or VSPX context. http://docs.openlinksw.com/virtuoso/fn_vacuum.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: DB.DBA.VACUUM Compact the databaseThis function reads through the specified tables and indices and finds groups of adjacent pages holding data that will fit on fewer pages than it currently occupies. If such a compression can be made, the pages are thus compacted. The pages become part of the committed state and will be written to the checkpoint space on the next checkpoint. The vacuum operation is non-locking and can be run on a busy database. It will simply skip pages with ongoing activity such as pending cursors or locks. The vacuum procedure returns only after it has read through the indices it affects but it will not prevent other activity on the indices. The vacuum operation may run out of disk space even if it makes net gains because the modified pages will not be final until the next checkpoint and the originals will not be free until this same checkpoint. Thus manually running a checkpoint after vacuum runs out of space will free the space and vacuum may be rerun. http://docs.openlinksw.com/virtuoso/fn_dateadd.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: dateadd arithmetic add to a datedateadd adds a positive or negative quantity of units to a date (in the internal date time format), and returns a new date so formed. The unit is specified as a string and can be one of the following: 'second', 'minute', 'hour', 'day', 'month', or 'year'. Use datestring to convert the result to a human-readable string. http://docs.openlinksw.com/virtuoso/fn_datediff.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: datediff get difference of 2 datesdatediff subtracts date1 from date2 and returns the difference as an integer in the specified units. http://docs.openlinksw.com/virtuoso/fn_datestring.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: datestring, datestring_gmt, convert a datetime from internal to external date-time representationdatestring and datestring_gmt convert timestamps or datetimes from internal to external date-time representation. The external representation is a human-readable ASCII string of up to 30 characters. The external format is: YYYY-MM-DD hh:mm:ss uuuuuu where uuuuuu represents microseconds. http://docs.openlinksw.com/virtuoso/fn_datestring_gmt.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: datestring_GMT convert a timestamp to external format string in GMTConverts the local datetime to GMT and returns its external representation as a string. http://docs.openlinksw.com/virtuoso/fn_dav_api_add.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: DAV add & update functions functions for adding, updating, deleting of DAV collections or resourcesDAV_COL_CREATE creates a new collection on path, with supplied security permissions, returning a collection id (COL_ID) upon success. DAV_RES_UPLOAD creates or replaces an existing resource on path with content, mime type and supplied security permissions. Returns a resource id (RES_ID) on success. DAV_DELETE Removes an existing collection/resource. If silent is set to a nonzero value, no errors codes will be returned. returns 1 on success. http://docs.openlinksw.com/virtuoso/fn_dav_api_change.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: DAV manipulation functions Functions for manipulating an existing DAV collection or resourceDAV_COPY copies the resource or collection taken from path to the destination. returns COL_ID or RES_ID on success. DAV_MOVE moves the collection or resource to the destination path returns 1 on success. DAV_PROP_SET defines or updates the property with name propname with propvalue. Returns PROP_ID on success. http://docs.openlinksw.com/virtuoso/fn_dav_api_lock.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: DAV lock manipulation functions Operations on locks of DAV collections and resourcesDAV_LOCK sets a new lock or refresh an existing lock or creates a lock object. DAV_UNLOCK releases a lock. DAV_IS_LOCKED reports whether the resource or collection is locked. http://docs.openlinksw.com/virtuoso/fn_dav_api_search.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: DAV search functions Functions for searching a DAV collection or resourceDAV_SEARCH_ID() returns the RES_ID or COL_ID, depending on the 'what' parameter passed. ('R'esource or 'C'ollection or 'P'arent collection). DAV_SEARCH_PATH() returns full path string of resource or collection, depending on parameter passed. ('R'esource or 'C'ollection or 'P'arent collection). DAV_DIR_LIST() returns an array of arrays that contains the following information about the requested path: http://docs.openlinksw.com/virtuoso/fn_dav_api_user.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: WebDAV Users & Groups administration Functions for manipulating an existing DAV collection or resourceDAV_ADD_USER() create a new WebDAV user with login name 'uid' and password 'pwd'. User will belong to the group named 'gid'. 'perms' are the default user permissions for creation of new resources. Additional user info supplied is 'home' directory, 'full name' and 'e-mail'. DAV_DELETE_USER() remove the existing webDAV user named 'uid'. DAV_HOME_DIR() returns the home folder for specified WebDAV user named 'uid'. http://docs.openlinksw.com/virtuoso/fn_dav_exp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: DAV_EXP Export a retrieved Web site to another WebDAV enabled serverThis function is used to export local content retrieved from a Web Robot Copy to the local file system. http://docs.openlinksw.com/virtuoso/fn_dayname.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: dayname decompose a datetime to its componentsThese functions decompose a datetime to its components. These can be used on timestamps, datetimes, dates and times, all being the same internal data type. http://docs.openlinksw.com/virtuoso/fn_dayofmonth.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com 2008-11-25T00:17:53Z Function: dayofmonth get day of month from a datetimedayofmonth takes a datetime and returns an integer containing day of the month represented by the datetime http://docs.openlinksw.com/virtuoso/fn_dayofweek.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com 2008-11-25T00:17:53Z Function: dayofweek get day of week from a datetimedayofweek takes a datetime and returns an integer containing a number representing the day of week of the datetime. http://docs.openlinksw.com/virtuoso/fn_dayofyear.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com 2008-11-25T00:17:53Z Function: dayofyear get day of year from a datetimedayofyear takes a datetime and returns an integer containing a number representing the day of year of the datetime. http://docs.openlinksw.com/virtuoso/fn_dbg_obj_print.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: dbg_obj_print print to the Virtuoso system consoledbg_obj_print prints a variable number of arguments onto the system console (stdout) of Virtuoso server, each argument in its own native format, on the same line, which is followed by one newline. http://docs.openlinksw.com/virtuoso/fn_dbg_printf.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: dbg_printf print formatted output onto the system consoledbg_printf prints a variable number (max. eight) of arguments to the system console of Virtuoso server, each argument formatted in C printf style, according to the format string specified in the first argument. http://docs.openlinksw.com/virtuoso/fn_dbname.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: dbname get current catalogReturns the current qualifier as set by the USE statement or default. http://docs.openlinksw.com/virtuoso/fn_delay.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: delay sleep for n secondsThis will halt calling procedure execution for specified interval in seconds. http://docs.openlinksw.com/virtuoso/fn_dict_duplicate.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_duplicate Creates a copy of the given dictionary.The function creates a full copy of the given dictionary. Dictionary objects are always passed by reference, even if dictionary is passed as an 'in' argument of a function. If value of a variable is a dictionary and it is assigned to other variable then both variables refer to the same internal hash table. This function returns a really independent dictionary object. This function duplicates the given dictionary but does not duplicate dictionaries that may be stored in key-value pairs. http://docs.openlinksw.com/virtuoso/fn_dict_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_get Returns the dependent part that corresponds to the given key in the given dictionary.The function returns the dependent part that corresponds to the given key in the given dictionary. The function returns default_value if the dictionary does not contain a pair whose key is equivalent to the given one. When only two arguments are passed to the function the default value is integer zero. http://docs.openlinksw.com/virtuoso/fn_dict_list_keys.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_list_keys Returns an array of all keys stored in the given dictionary.The function returns an array of all keys stored in the given dictionary, ignoring dependent parts of key-value pairs. This is especially useful when dictionary is used to form a set of dictinct keys, when dependent parts are fake (typically zeroes). If the destructive parameter is nonzero then the function may avoid copying of keys to the resulting array by moving them out from the dictionary. This is faster but the dictionary will become empty at the end of operation. The destructive parameter does not have any effect if the dictionary is used as a value of more than one variable. Thus it is safe to make this parameter nonzero as soon as the variable passed to the function as dict is no longer in use after the function call and there's no need to inspect the whole program to check if other variables may be affected. http://docs.openlinksw.com/virtuoso/fn_dict_new.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_new Creates a new dictionary to store key-value pairs.This function creates a new dictionary. A dictionary is a memory-resident hash table that can store an arbitrary number of key-value pairs. Both key and dependent part can be of any type, including vectors. Two keys of different data types are always considered as different even if SQL '=' operator return 'true', e.g. integer zero and double precision 0.0 are two different keys. Vectors are equivalent if their corresponding members are either equal scalars or equivalent vectors. XML entities are equivalent if they refer to the same node or attribute in the same document. Dictionary objects are always passed by reference, even if dictionary is passed as an 'in' argument of a function. If value of a variable is a dictionary and it is assigned to other variable then both variables refer to the same internal hashtable. To create two really independent dictionary objects, use dict_duplicate (). http://docs.openlinksw.com/virtuoso/fn_dict_put.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_put Adds a key-value pair to a dictionaryThe function adds or updates a key-value pair in the given dictionary. If the dictionary contains a pair with the key part equivalent to the given one then old value is replaced with a new one. Otherwise, a new pair is added to the dictionary. http://docs.openlinksw.com/virtuoso/fn_dict_remove.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_remove Removes the given key and associated dependent value from the given dictionary.The function removes the given key and the associated dependent value from the given dictionary. If the key-value pair is found (and removed) the function returns 1. If the dictionary does not contain a key equivalent to the given one the function returns zero. http://docs.openlinksw.com/virtuoso/fn_dict_to_vector.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Dictionary Manipulation 2008-11-25T00:17:53Z Function: dict_to_vector Returns a get_keyword style vector of all items stored in the given dictionary.The function returns an array of all data stored in the given dictionary, every pair is represented as two consecutive element of the resulting array. Thus the dictionary of N pairs is converted into a vector of length 2N where keys are at positions 0, 2, 4, ..., 2N-1 and corresponding dependent data are at positions 1, 3, 5, ..., 2N. If keys are all scalars of same type then get_keyword function can be used to search in the resulting array. If the destructive parameter is nonzero then the function may avoid copying of keys to the resulting array by moving them out from the dictionary. This is faster but the dictionary will become empty at the end of the operation. The destructive parameter does not have any effect if the dictionary is used as a value of more than one variable. Thus it is safe to make this parameter nonzero as soon as the variable passed to the function as dict is no longer in use after the function call and there's no need to inspect the whole program to check if other variables may be affected. http://docs.openlinksw.com/virtuoso/fn_disconnect_user.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: disconnect_user Disconnect client connections of a given userdisconnect_user disconnects clients whose username matches the username_pattern string given as an argument, and returns an integer value giving the number of clients disconnected. This can be used after DELETE USER or REVOKE statement to make sure that the affected user has no open connections. http://docs.openlinksw.com/virtuoso/fn_dt_set_tz.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: dt_set_tz modifies the timezone component of a datetimeThis modifies the timezone component of a datetime. The value remains equal for purposes of comparison but will look different when converted to a string. The timezone component is an offset from UTC in minutes. It can be retrieved with the timezone function. http://docs.openlinksw.com/virtuoso/fn_dvector.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: dvector return an array of either long, float or double These functions are like vector but return an array of either long, float or double whereas vector returns a generic, untyped array. http://docs.openlinksw.com/virtuoso/fn_end_result.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: end_result End the current result set.The result_names() predefines variables to be used in a result set to follow. The variables must be previously declared, from which the column data types are ascertained. This assigns the meta data but does not send any results. The result() function sends its parameters as a single row of results. These parameters should be compatible with those in the previous result_names(). The end_result() function can be used to separate multiple result sets. The result_names() can then be used to alter the result set structure. The result_names() call can be omitted if the application already knows what columns and their types are to be returned. http://docs.openlinksw.com/virtuoso/fn_either.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: either conditionally return one of specified parameterseither returns a copy of arg1 if cond is something else than integer 0 (zero). Otherwise, a copy of arg2 is returned. http://docs.openlinksw.com/virtuoso/fn_elh_get_handler.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: elh_get_handler get localization function handler http://docs.openlinksw.com/virtuoso/fn_elh_load_handler.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Locale 2008-11-25T00:17:53Z Function: elh_load_handler load encoding handler into system Loads given handler in table of handlers bound to encoding specified in the handler, using ISO 639 and RFC 1766 language IDs of the handler as keys for future table lookups. If another handler was already specified for given RFC 1766 id, table entry will be updated and will refer to new handler. If another handler was already specified for given ISO 639 id, it will be replaced only if new handler has ISO 639 language ID equal to its RFC 1766 ID. Please do not load custom versions of 'x-any' and 'x-ftq-x-any' handlers. http://docs.openlinksw.com/virtuoso/fn_encode_base64.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Encoding & Decoding 2008-11-25T00:17:53Z Function: encode_base64 base64-encode/decode a stringThese functions convert strings from/to base64-encoding. http://docs.openlinksw.com/virtuoso/fn_equ.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: equ comparison functionsThese functions return 1 if their first argument is less than (lt), less than or equivalent (lte), greater than (gt), greater than or equivalent (gte), equivalent (equ), or not equivalent (neq) to the second argument, respectively. If the arguments are not of the same type, then an appropriate type coercion is done for them before comparison. These functions correspond to SQL query operators <, <=, >, >=, = and <> and are needed because the SQL syntax does not allow these operators to be used on the left side of FROM keyword in a SELECT statement. http://docs.openlinksw.com/virtuoso/fn_exec.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec dynamic execution of SQL returning state and result setThis function provides dynamic SQL capabilities in Virtuoso PL. The first argument is an arbitrary SQL statement, which may contain parameter placeholders. The function returns as output parameters a SQL state, error message, column metadata and result set rows if the statement is a select. A stored procedure can be invoked by exec but a procedure's result set will not be received in the rows output parameter but rather sent to the client. http://docs.openlinksw.com/virtuoso/fn_exec_close.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: close Closes cursor created by exec()Closes the cursor opened by the exec() function. http://docs.openlinksw.com/virtuoso/fn_exec_next.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec_next Get next result from a result setUse exec_next() to iterate over a result set produced by a statement run with exec. http://docs.openlinksw.com/virtuoso/fn_exec_result.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec_result Returns a result set row to the calling procedure contextThis function returns a result set row to the calling procedure's context, whether it is the client, exec function or a procedure view). The row's values are the elements of the supplied res_values_array vector. http://docs.openlinksw.com/virtuoso/fn_exec_result_names.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec_result_names Supplies column details for procedure result set output.This function allows you to define the column details for result sets returned by procedures, in particular for use with the exec() function. This function is similar to result_names(). http://docs.openlinksw.com/virtuoso/fn_exec_metadata.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec_metadata Compiles a SQL statement and returns the metadataThis function provides dynamic SQL capabilities in Virtuoso PL. The first argument is an arbitrary SQL statement, which may contain parameter placeholders. The function returns as output parameters a SQL state, error message, column metadata if the statement is a select. http://docs.openlinksw.com/virtuoso/fn_exec_score.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SQL 2008-11-25T00:17:53Z Function: exec_score Compiles a SQL statement and returns the estimate time costThis function provides dynamic SQL capabilities in Virtuoso PL. The first argument is an arbitrary SQL statement, which may contain parameter placeholders. The function returns as output parameters a SQL state, error message and returns the estimate time cost in milliseconds. http://docs.openlinksw.com/virtuoso/fn_exp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: exp calculate exponentThe function raises e to the power of x, it works with double precision floating point numbers, converts its argument to an IEEE 64-bit float and returns a result of that type. http://docs.openlinksw.com/virtuoso/fn_explain.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Debug 2008-11-25T00:17:53Z Function: explain describe SQL statement compilation The explain function compiles a SQL statement and returns a description of that compilation as a result set, return value or parse tree. The result set consists of one VARCHAR column with one line of the description in each row. Any given line may be quite long, even several hundred characters. The output is not a complete disassembly of the query graph, but it is detailed enough to show the join order, the sub-query structure, and the order of evaluation of query predicates, as well as the splitting of a distributed VDB query over different data sources. The optional cursor type can be one of the SQL_CURSOR_<xx> constants, or one of the special values listed below. The default is 0, for FORWARD ONLY. The special values each have special effect, as listed. If the statement is a SELECT and the cursor type is not FORWARD ONLY, the auxiliary SQL statements used by the cursor implementation are shown. http://docs.openlinksw.com/virtuoso/fn_file_delete.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_delete Delete a file from the file systemThis function requires dba privileges. This function is used to delete a file from file system. This function has a silent mode, where no errors will be signalled upon failure. http://docs.openlinksw.com/virtuoso/fn_file_dirlist.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_dirlist Returns list with content of file system directoryThis function requires dba privileges. This returns the list of the contents of a given file system directory. http://docs.openlinksw.com/virtuoso/fn_file_mkdir.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_mkdir Creates a directory in the file systemThis function requires dba privileges. This function creates a file system directory. http://docs.openlinksw.com/virtuoso/fn_file_mkpath.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_mkpath Make a directory chainThis function requires dba privileges. This is to create a directory chain i.e. 'a/b/c/d', where one or more elements in the path may not exist. http://docs.openlinksw.com/virtuoso/fn_file_stat.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_stat get various OS statistics about a filefile_stat returns various information for an OS file by calling stat () system call and converting the relevant value to a varchar. The path is relative to the server's working directory. The what is an integer value selecting what information to return. If you don't supply second argument to the function it defaults to mode = 0. The DirsAllowed and DirsDenied lists in Parameters section of the virtuoso configuration file (virtuoso.ini by default) are not used to control disk access. http://docs.openlinksw.com/virtuoso/fn_file_to_string.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_to_string returns the contents of a file as a varcharThis function requires dba privileges. Returns the contents of a file as a varchar value. The file's length is limited to 16 MB. The path is relative to the working directory of the database server. http://docs.openlinksw.com/virtuoso/fn_file_to_string_output.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_to_string_output get contents of a file as a string output streamThis function requires dba privileges. This function returns a string output stream initialized to contain the text of the file or its segment, on local file system path relative to the server's working directory. file_to_string_output can handle longer files than file_to_string and the resulting string output, if too long to be converted into a varchar, can be stored inside a blob. http://docs.openlinksw.com/virtuoso/fn_file_unlink.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com File Manipulation 2008-11-25T00:17:53Z Function: file_unlink Delete a file from the file systemThis function requires dba privileges. This function deletes a file from the file system. sys_unlink is a synonym of this function. http://docs.openlinksw.com/virtuoso/fn_fk_check_input_values.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Administration 2008-11-25T00:17:53Z Function: fk_check_input_values alter default foreign key checking behavior Enforcing foreign key constraints is enabled by default. This function allows globally disabling it without however disabling all triggers. This may be useful for large data imports or other special circumstances. The return value is the previous state of this setting, 0 for off, 1, for on. The effect of this function is persistent and survives server restart. http://docs.openlinksw.com/virtuoso/fn_floor.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Number 2008-11-25T00:17:53Z Function: floor Round a number to negative infinity.floor calculates the largest integer smaller than or equal to x. http://docs.openlinksw.com/virtuoso/fn_ftp_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: ftp_get FTP get command; Virtuoso FTP clientVirtuoso has FTP client functionality, that can be used inside Virtuoso/PL. This Virtuoso function mimics the FTP get command. As with any PL, this can be combined with Web Services and SOAP. http://docs.openlinksw.com/virtuoso/fn_ftp_ls.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: ftp_ls FTP dir command; Virtuoso FTP clientVirtuoso has FTP client functionality, that can be used inside Virtuoso/PL. This Virtuoso function mimics the FTP dir command. As with any PL, this can be combined with Web Services and SOAP. http://docs.openlinksw.com/virtuoso/fn_ftp_put.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: ftp_put FTP put command; Virtuoso FTP clientVirtuoso has FTP client functionality, that can be used inside Virtuoso/PL. This Virtuoso function mimics the FTP put command. As with any PL, this can be combined with Web Services and SOAP. http://docs.openlinksw.com/virtuoso/fn_get_certificate_info.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: get_certificate_info Returns information about the current client X509 certificate This function will return information about the current client X509 certificate (if successfully verified). If there is no valid X509 certificate or the requested information is not available it will return NULL. If the optional cert_or_key_name is supplied it should contain a encoded certificate (by default format is PEM). The certificate info is read from the first certificate in that string. If the optional cert_or_key_name is supplied and in_format is equal to 3 (integer) the function will try to retrieve the certificate registered in the current user's key store by name contained in cert_or_key_name. http://docs.openlinksw.com/virtuoso/fn_get_keyword.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: get_keyword Find a value in keyword vectorget_keyword performs a case sensitive seek for the occurrence of keyword from each even position of searched_array. If found,this returns the element following the occurrence of the keyword. If the keyword is not found this returns the default argument or NULL if the default is not supplied. http://docs.openlinksw.com/virtuoso/fn_get_keyword_ucase.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Array Manipulation 2008-11-25T00:17:53Z Function: get_keyword_ucase Find a value in keyword vector (search uppercase)Identical to get_keyword except all comparisons are performed case insensitively. http://docs.openlinksw.com/virtuoso/fn_get_timestamp.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: get_timestamp returns the timestamp of the current transactionget_timestamp is merely an alias for now and is provided for backward compatibility. http://docs.openlinksw.com/virtuoso/fn_getdate.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Date & Time Manipulation 2008-11-25T00:17:53Z Function: getdate returns the current transaction timestamp, alias of nowgetdate() returns the timestamp associated with current transaction. This is an alias of now(). http://docs.openlinksw.com/virtuoso/fn_gz_compress.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Compression 2008-11-25T00:17:53Z Function: gz_compress Compress data using gzip algorithm The gz_compress returns its argument compressed with the gzip algorithm. The argument and return values are arbitrary strings, possibly including any 8 bit characters. http://docs.openlinksw.com/virtuoso/fn_gz_uncompress.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Compression 2008-11-25T00:17:53Z Function: gz_uncompress Uncompress a string using gzip algorithmgz_uncompress takes a string argument, uncompresses it using the gzip algorithm, writing it to a string_output given as the second argument. http://docs.openlinksw.com/virtuoso/fn_hour.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com 2008-11-25T00:17:53Z Function: hour get hour from a datetimehour takes a datetime and returns an integer containing a number representing the hour of the datetime. http://docs.openlinksw.com/virtuoso/fn_http.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http write to HTTP client or a string output streamhttp writes val_expr to HTTP client or, if parameter stream is given, to the given string output stream. val_expr may be any scalar object, i.e. string, date or number and will automatically be cast to varchar before further processing. http will print out the string without escapes. http_value uses HTML escapes and http_url URL escapes. http://docs.openlinksw.com/virtuoso/fn_http_acl_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_acl_get Test conditions against web server ACL'sThis function can be used within application logic to test that an internet client would not violate the ACL. http://docs.openlinksw.com/virtuoso/fn_http_body_read.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com SOAP 2008-11-25T00:17:53Z Function: http_body_read Reads the HTTP body from the client HTTP connection and returns it as a string. This function reads the HTTP body from the client HTTP connection and returns it as a string output. This is suitable for processing POST requests with bodies encoded differently than multipart/* and application/x-www-form-urlencoded as in SOAP requests where the POST body is encoded as text/xml). http://docs.openlinksw.com/virtuoso/fn_http_client.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_client returns a varchar containing the body of the request uriThis function is used to perform HTTP operations to retrieve generic content and/or to perform generic operations over HTTP/HTTPS protocols. It also supports HTTP authentication based on username/password credentials. If the URL is https: an no x509 certificate given then it will operate as https client w/o client certificate. http://docs.openlinksw.com/virtuoso/fn_http_client_ip.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_client_ip Returns the IP address of the calling client.This function is used to determine the IP address or DNS name of the calling client. Please note that this function is slow when resolving a DNS names. It is advisable to use IP addresses to to make applications faster. http://docs.openlinksw.com/virtuoso/fn_http_debug_log.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_debug_log set WebDAV HTTP request loggingWhen an valid path string is supplied and it is allowed in file ACL list, the WebDAV HTTP requests and responses will be logged in append mode in to that file. When an open logging session is encountered the second call will produce an error. Specifying a NULL instead of file_path string stops the logging. The log file consists of lines with following fields: http://docs.openlinksw.com/virtuoso/fn_http_enable_gz.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_enable_gz Enable / Disable "Content-Encoding: gzip" for HTTP server Enable (1)/ Disable (0) "Content-Encoding: gzip" for HTTP server. http://docs.openlinksw.com/virtuoso/fn_http_file.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_file Send a file to the HTTP client This function causes the contents of the file specified by path to be sent as the response of the calling request. The file is not sent until the code calling this returns. Content types etc. are defaulted based on the file's extension. If this function is called, other output to the HTTP client by the caller is discarded. http://docs.openlinksw.com/virtuoso/fn_http_flush.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_flush Flush internal HTTP stream and disconnect client; Flush HTTP stream and try sending data in chunked mode. This flushes the internal buffer where output of a VSP page is stored pending the execution of the page's code. This sends the content of the page output buffer along with headers and disconnects the client. The status is 200 OK by default, unless overridden by http_status. The purpose of this function is to allow a page to send output before terminating , thus the page can continue processing for an indefinite time without requiring the client to wait. This is useful for starting long running background tasks from HTTP clients. VSP pages that use this function must be sure to supply appropriate content (or response headers) if needed before calling this function. Virtuoso supports HTTP 1.1 Chunking Encoding which allows Virtuoso to send the user agent chunks of output as the page is still processing. Chunking is enabled by calling http_flush(1) within the VSP page. By default chunks are sent for every 4k worth of output generated, but in some cases the output needs to consist of smaller chunks, for example when run-time status needs to be shown in a status page. So to achieve this the http_flush (try_what=1) could be invoked in places where chunk must be flushed to the User agent. http://docs.openlinksw.com/virtuoso/fn_http_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_get returns a varchar containing the body of the request urihttp_get returns a varchar containing the body of the requested target_uri or NULL if the body is not received. http://docs.openlinksw.com/virtuoso/fn_http_header.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_header Specifies non-default HTTP response headers This function is used to add additional HTTP header lines to the server response. The http_header parameter MUST finish with <CR><LF> characters. Warning: Each call of this function cancels the effect of the previous call. In order to add to previously set header lines, use the http_header_get function to retrieve the current headers. A Content-Type or Media-Type header specified as a part of the headers given with this function will override the default. Otherwise the header lines set using this function add to but do not replace the default response headers. Note that this function cannot set the status line. Use http_request_status for that. http://docs.openlinksw.com/virtuoso/fn_http_header_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_header_get returns header of current HTTP request Returns the response header associated with the current HTTP request. This will not return the default header lines, only those explicitly set with http_header. This is useful for incrementally modifying response headers during processing of a URL. http://docs.openlinksw.com/virtuoso/fn_http_kill.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_kill Kill VSP process whose details match parameter inputsThis function requires dba privileges. This function is used to kill the process whose details match that of the input parameters. If Client's IP and URL are specified, then it will try to kill all matching pending HTTP requests for that peer requesting that URL. If all three parameters are given, then it will try to kill only that pending HTTP request. http://docs.openlinksw.com/virtuoso/fn_http_listen_host.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_listen_host Starts, stops and retrieves the state of a user-defined HTTP listenerThis function requires dba privileges. This function is used to start, stop or lookup the state of user-defined HTTP and HTTPS listeners. The return value is 0 or 1 and indicates state of the listener, 1 for started and 0 for stopped. http://docs.openlinksw.com/virtuoso/fn_http_map_table.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_map_table Update internal HTTP mapping tableThis function requires dba privileges. This function inserts an entry defining a virtual directory into the HTTP maps table. http://docs.openlinksw.com/virtuoso/fn_http_map_get.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_map_get get values from HTTP virtual host path mapping table Retrieves information associated with the virtual host / HTTP path mapping in effect for the VSP page being processed. Values valid in current connection or URL context may be retrieved by element_name. Calling http_map_get has no use outside of http context. In this case an error will be signalled. http://docs.openlinksw.com/virtuoso/fn_http_param.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_param returns value of a HTML form parameter in VSP contextThis function is used to return value of a HTML form parameter in VSP context. It's almost like call get_keyword ('name', params) used in VSP programming. When 'name' parameter is not supplied, the result of http_param() call will be all parameters, as they are contained in 'params' parameter of the VSP pages. This function is useful in HTTP authentication PL hook, as in this place there is no 'params' argument. http://docs.openlinksw.com/virtuoso/fn_http_path.html virtuoso.docs@openlinksw.com virtuoso.docs@openlinksw.com Web Server & Internet 2008-11-25T00:17:53Z Function: http_path returns the absolute path to the logical path location of the c