www.openlinksw.com
docs.openlinksw.com

Book Home

Contents
Preface

Overview
Installation Guide
Quick Start & Tours
Sample ODBC & JDBC Applications
Conceptual Overview
Server Administration
Data Access Interfaces
SQL Reference
SQL Procedure Language Guide
Database Event Hooks
Data Replication, Synchronization and Transformation Services
Web Application Development
XML Support
RDF Database and SPARQL
Web Services
Runtime Hosting
Internet Services
Free Text Search
TPC C Benchmark Kit
Using Virtuoso with Tuxedo
Appendix
Virtuoso Functions Guide

OpenLink Virtuoso Universal Server: Documentation - Function Index

integer __any_grants (in tablename varchar);
Checks a table for grants.
abs (in num any);
Return the absolute value of a number
acos (in x double precision);
trigonometric functions
boolean and ( val1 boolean, val2 boolean, ... , valN boolean);
Returns false if a value of some argument is false, otherwise returns true.
sequence append ( seq1 sequence, seq2 sequence, ... , seqN sequence);
Creates an sequence of all items from given sequences.
aref ( arg any, nth integer);
returns specific element of an array or string
integer ascii ( arg any);
Get ASCII value of a character
aset (in arg any, in nth integer, in new_elem any);
set array element
asin (in x double precision);
trigonometric functions
null assign ( var_name string, var_value any);
Creates a local variable and assign a value to it.
atan (in x double precision);
trigonometric functions
atan2 (in x double precision, in y double precision);
trigonometric functions
atof (in arg string);
Convert a string to single precision float
atoi (in arg string);
Convert a string to an integer
varchar att_local_name (in dsn varchar, in table varchar);
Compose a fully qualified table name based on DSN and remote table name.
number avg ( arg1 any, arg2 any, ... , argN any);
Returns average value of all its arguments.
backup (in file varchar);
Write data into transaction log format for backup purposes. Deprecated.
Write data into transaction log format for backup purposes. Deprecated.
Clears the backup context and marks all pages in checkpoint space as ready for online backup
Write data into transaction log format for backup purposes. Deprecated.
int backup_online (in file_prefix varchar, in pages integer, [in timeout integer], [in dirs any]);
perform online backup of database
backup_prepare (in file varchar);
Write data into transaction log format for backup purposes. Deprecated.
backup_row (in row any);
Write data into transaction log format for backup purposes. Deprecated.
caddr_t bif_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_array_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_array_or_null_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_bin_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_double_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_entity_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_float_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_long_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_long_or_char_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_string_arg (state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_string_or_null_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_string_or_wide_or_null_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
caddr_t bif_strses_arg (caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
bit_and (in n1 integer, in n2 integer);
Returns bitwise AND of two 32-bit integers.
bit_not (in n1 integer);
Returns bitwise NOT of a 32-bit integer.
bit_or (in n1 integer, in n2 integer);
Returns bitwise OR of two 32-bit integers.
bit_shift (in value integer, in distance integer);
Returns the result of bitwise shift opertion over two 32-bit integers.
bit_xor (in n1 integer, in n2 integer);
Returns bitwise XOR (exclusive "or") of two 32-bit integers.
Convert a blob to string
Convert a blob to string session
any bookmark (in cursor CURSOR);
Return the bookmark for current row of a scrollable cursor
Converts its argument to boolean
BPEL.BPEL.compile_script (in scp_id int, in vdir varchar (default null), in opts any (default null), in no_check int (default 0));
Compile a BPEL script source
BPEL.BPEL.copy_script (in scp_id int);
Makes a copy of an existing script
Retrurns a list of partner links used in the BPEL script
BPEL.BPEL.getVariableData (in var_name varchar, in part varchar, in query varchar);
gets BPEL variable data within <bpelv:exec binding="SQL"> activity
BPEL.BPEL.import_script (in base_uri varchar, in base_name varchar, in scp_id int);
Import a new BPEL process
delete a BPEL process instance
BPEL.BPEL.plink_get_option (in script varchar, in plink varchar, in opt varchar);
retrieving a partner link option
BPEL.BPEL.plink_set_option (in script varchar, in plink varchar, in opt varchar, in val any);
set value of a partner link option
BPEL.BPEL.purge_instance (in completed_before datetime, in make_archive int (default 1));
removes old BPEL process instances
BPEL.BPEL.script_delete (in script varchar, in delete_instances int);
Remove a BPEL process
BPEL.BPEL.script_obsolete (in script varchar);
mark a BPEL script as obsoleted
BPEL.BPEL.script_source_update (in scp_id int, in url varchar, in content any);
Updates an existing script in BPEL repository
BPEL.BPEL.script_upload (in name varchar, in url varchar, in content any);
Upload a new BPEL script source
BPEL.BPEL.setVariableData (in var_name varchar, in value any, in part varchar, in query varchar);
sets BPEL variable data within code invoked from <bpelv:exec binding="SQL"> activity
BPEL.BPEL.wsdl_upload (in scp_id int, in url varchar, in content any, in pl varchar default 'wsdl');
Uploads a WSDL description for a given BPEL script
ceiling (in x double precision);
Round a number to positive infinity.
integer ceiling ( num number);
Returns the smallest integer that is not less than the argument.
cfg_item_count (in path varchar, in section varchar);
return number of items in a section in configuration file
cfg_item_name (in path varchar, in section varchar, in item_index integer);
get nth item name from ini file
cfg_item_value (in path varchar, in section varchar, in item_name varchar);
returns the value of an item from the ini file
cfg_section_count (in path varchar);
get number of sections in an INI file
cfg_section_name (in path varchar, in index integer);
returns INI file section name
cfg_write (in path varchar, in section varchar, in item_name varchar, in item_value varchar);
Writes the item=value to an INI file
charset_define (in name varchar, in charset_string any, in aliases any);
Define a character set.
any charset_recode (in src_string varchar/nvarchar, in src_charset varchar, in dst_charset varchar);
Translate a string to another character set
any charsets_list (in gen_res_set integer);
List known character set names and aliases.
integer checkpoint_interval (in minutes integer);
Configure database checkpointing
varchar chr (in chr_codelong);
Convert a long character code to a character or wide character
varchar client_attr (in attr varchar);
returns a varchar containing the requested information from the connection
collation_define (in COLLATION_NAME varchar, in FILE_PATH varchar, in ADD_TYPE integer);
define a new collation
varchar complete_table_name (in tablename varchar, in mode integer);
Returns a fully qualified table name.
create a composite object
integer composite_ref (in c any, in nth integer);
get member of a composite object
concat ( str1 varchar, str2 varchar, ... , strn varchar);
Concatenate strings
string concat ( strg1 string, strg2 string, ... , strgN string);
Returns the concatenation of its arguments.
string concatenate (in arg_1 any, ... );
concatenate strings
any connection_get (in name varchar);
Get connection variable
get connection identifier
check if current session connection variables have been altered
connection_set (in name varchar, in value any);
Associates a value to the name in the context of the present connection
Retrieve all connection variables
connection_vars_set (in var_array any);
set all connection variables
boolean contains ( column varchar, expression varchar, [opt_or_valueinteger]);
A text contains predicate
boolean contains ( haystack string, needle string);
Returns true if the first argument string contains the second argument string, and otherwise returns false.
numeric CORR (in expr1 any, in expr2 any);
Returns the coefficient of correlation of a set of number pairs.
cos (in x double precision);
trigonometric functions
cot (in x double precision);
trigonometric functions
integer count ( seq any);
Returns the number of values in the sequence.
cov_load (in fname varchar);
Load test coverage data from file.
cov_report (in fname varchar, in outdir varchar);
Produce a text coverage report.
cov_store (in fname varchar, in add_comments integer);
Writes a test coverage to a file.
numeric COVAR_POP (in expr1 any, in expr2 any);
Returns the population covariance of a set of number pairs.
numeric COVAR_SAMP (in expr1 any, in expr2 any);
Returns the sample covariance of a set of number pairs.
attribute create-attribute ( attrname string, attrvalue string);
Creates a special "attribute descriptor" object.
entity create-comment ( comment-text string);
Creates a "comment" XML tree entity.
node create-element ( head sequence, child1 any, child2 any, ... , childN any);
Creates an element with specified name, attributes and children
entity create-pi ( piname string); ( pivalue string);
Creates a "procesing instruction" XML tree entity.
XMLType createXML (in src any, [in schema_uri any], [in validated any], [in wellformed any]);
get current date and time
get current date and time
Returns a node-set that has the current node as its only member.
Get name of current charset.
get current date and time
dateadd (in unit string, in number integer, in date datetime);
arithmetic add to a date
datediff (in unit string, in date1 datetime, in date2 datetime);
get difference of 2 dates
datestring (in date datetime);
convert a datetime from internal to external date-time representation
datestring_gmt (in date datetime);
convert a datetime from internal to external date-time representation
datestring_GMT (in dt datetime);
convert a timestamp to external format string in GMT
integer DAV_ADD_GROUP (in gid varchar, in auth_uid varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
integer DAV_ADD_USER (in uid varchar, in pwd varchar, in gid varchar, in permis varchar, in disable integer, in home varchar, in full_name varchar, in email varchar, in uid varchar, in auth_uid varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
integer DAV_COL_CREATE (in path varchar, in permissions varchar, in uname varchar, in gname varchar, in auth_uname varchar, in auth_pwd varchar);
functions for adding, updating, deleting of DAV collections or resources
integer DAV_COPY (in path varchar, in destination varchar, in overwrite integer, in permissions varchar, in uname varchar, in gname varchar, in auth_uname varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
integer DAV_DELETE (in path varchar, in silent integer, in auth_uname varchar, in auth_pwd varchar);
functions for adding, updating, deleting of DAV collections or resources
varchar DAV_DELETE_GROUP (in gid varchar, in auth_uid varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
varchar DAV_DELETE_USER (in uid varchar, in auth_uid varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
any DAV_DIR_LIST (in path varchar, in recursive integer, in auth_uid varchar, in auth_pwd varchar);
Functions for searching a DAV collection or resource
WS.WS. DAV_EXP (in host varchar, in url varchar, in root varchar, in dst varchar);
Export a retrieved Web site to another WebDAV enabled server
varchar DAV_HOME_DIR (in uid varchar);
Functions for manipulating an existing DAV collection or resource
varchar DAV_MOVE (in path varchar, in destination varchar, in overwrite integer, in auth_uname varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
varchar DAV_PROP_REMOVE (in path varchar, in propname varchar, in silent integer, in auth_uname varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
integer DAV_PROP_SET (in path varchar, in propname varchar, in propvalue any, in auth_uname varchar, in auth_pwd varchar);
Functions for manipulating an existing DAV collection or resource
varchar DAV_RES_UPLOAD (in path varchar, in content any, in type varchar, in permissions varchar, in uname varchar, in gname varchar, in auth_uname varchar, in auth_pwd varchar);
functions for adding, updating, deleting of DAV collections or resources
integer DAV_SEARCH_ID (in path varchar, in what char(1));
Functions for searching a DAV collection or resource
varchar DAV_SEARCH_PATH (in id integer, in what char(1));
Functions for searching a DAV collection or resource
dayname (in dt datetime);
decompose a datetime to its components
dayofmonth (in dt datetime);
decompose a datetime to its components
dayofmonth (in dt datetime);
get day of month from a datetime
dayofweek (in dt datetime);
decompose a datetime to its components
dayofweek (in dt datetime);
get day of week from a datetime
dayofyear (in dt datetime);
decompose a datetime to its components
dayofyear (in dt datetime);
get day of year from a datetime
DB.DBA.VACUUM (in table_name varchar (default %), in index_name varchar (default %));
Compact the database
dbg_obj_print (in arg1 any, ... );
print to the Virtuoso system console
dbg_printf (in format varchar, in arg1 any, ... , in argn any);
print formatted output onto the system console
get current catalog
decode_base64 (in str varchar);
base64-encode/decode a string
degrees (in x double precision);
trigonometric functions
delay (in n_seconds integer);
sleep for n seconds
convert any heterogeneous array or tree of arrays into a binary string and back
dictionary dict_duplicate (in dict dictionary);
Creates a copy of the given dictionary.
any dict_get (in dict dictionary, in key any, [in default_value any]);
Returns the dependant part that corresponds to the given key in the given dictionary.
vector dict_list_keys (inout dict dictionary, in destructive any);
Returns an array of all keys stored in the given dictionary.
dictionary dict_new ([in size integer]);
Creates a new dictionary to store key-value pairs.
int dict_put (inout dict dictionary, in key any, in value any);
Adds a key-value pair to a dictionary
int dict_remove (inout dict dictionary, inout key any);
Removes the given key and associated dependent value from the given dictionary.
vector dict_to_vector (inout dict dictionary, in destructive any);
Returns a get_keyword style vector of all items stored in the given dictionary.
disconnect_user (in username_patternstring);
Disconnect client connections of a given user
sequence distinct ( input sequence);
Removes double entities from the input sequence
node-set doc ( document_uri varchar);
Returns data from XML doc other than the main source document.
node-set document ( document_uri varchar, [base_uri varchar], [parser_mode integer], [content_encoding varchar], [content_language varchar], [dtd_validator_config varchar]);
Returns data from XML documents other than the main source document.
node-set document-literal ( document_text varchar, [cache_uri varchar], [parser_mode integer], [content_encoding varchar], [content_language varchar], [dtd_validator_config varchar]);
Parses given XML text and returns the resulting XML data.
varchar dsig_template_ext (in xdoc any, in tmpl varchar, in wss_ver any, in ns-n varchar, in elm-n varchar, in ... varchar);
Generates a Digital signature template based on a XML document.
dt_set_tz (in dt datetime, in tz integer);
modifies the timezone component of a datetime
dv_type_title ( internal_type integer);
returns the internal type name of the argument
array dvector ( elt1 , .... , elt-n );
return an array of either long, float or double
either (in cond any, in arg1 any, in arg2 any);
conditionally return one of specified parameters
encodedlang_handler_t * elh_get_handler (encoding_handler_t * encoding , language_handler_t * language );
get localization function handler
int elh_load_handler (encodedlang_handler_t * new_handler );
load encoding handler into system
boolean empty ( seq any);
Returns true if given argument is an empty sequence, false if it is any single value or nonempty sequence.
encode_base64 (in str varchar);
base64-encode/decode a string
End the current result set.
boolean ends-with ( strg string, suffix string);
Returns true if the first argument string ends with the second argument string, and otherwise returns false.
equ ( arg1 any, arg2 any);
comparison functions
boolean every ( varname string, test_set sequence, test_expn boolean);
Returns true if all items of given sequence matches given criterion.
sequence except ( set1 sequence, set2 sequence);
Returns a difference of two sets
exec (in str varchar, out state varchar, out message varchar, in params any, in maxrows integer, out metadata vector, out rows vector, out cursor_handle long);
dynamic execution of SQL returning state and result set
exec_close (in cursor_handle long);
Closes cursor created by exec()
integer retcode exec_next (in cursor_handle long, out sql_state varchar, out sql_error varchar, out row_array vector);
Get next result from a result set
any exec_result (in res_values_array any);
Returns a result set row to the calling procedure context
exec_result_names (in res_names_array any);
Supplies column details for procedure result set output.
exp (in x double precision);
calculate exponent
explain (in textvarchar, [in cursor_type integer]);
describe SQL statement compilation
Returns false.
integer file_delete (in path varchar, in silent integer);
Delete a file from the file system
file_dirlist (in path varchar, [in what integer], [out error any]);
Returns list with content of file system directory
file_mkdir (in path varchar, [out error any]);
Creates a directory in the file system
file_mkpath (in path varchar, [inout istest integer]);
Make a directory chain
file_stat (in path varchar, in what integer);
get various OS statistics about a file
varchar file_to_string (in path varchar);
returns the contents of a file as a varchar
file_to_string_output (in file varchar, in from integer, in to integer);
get contents of a file as a string output stream
file_unlink (in path varchar);
Delete a file from the file system
node-set filter ( selection sequence);
Composes trees of shallow copies of given XML entities.
alter default foreign key checking behavior
floor (in x double precision);
Round a number to negative infinity.
integer floor ( num number);
Returns the largest integer that is not greater than the argument.
node()* fn:collection ([uri anyURI], [base_uri string], [recursive_mode int], [parser_mode int], [encoding string], [language string], [dtd_config string]);
Returns parsed documents contained in given collections.
any for ( varname string, source_set sequence, mapping_expn any);
Repeats some calculation for every item of a given sequence
string format-number ( num number, format_pattern string, [decimal_format string]);
integer ftp_get (in server varchar, in user varchar, in pass varchar, in remote_file_name varchar, in local_file_name varchar, [in is_pasv integer]);
FTP get command; Virtuoso FTP client
any ftp_ls (in server varchar, in user varchar, in pass varchar, in remote_dir_name varchar, [in is_pasv integer]);
FTP dir command; Virtuoso FTP client
integer ftp_put (in server varchar, in user varchar, in pass varchar, in local_file_name varchar, in remote_file_name varchar, [in is_pasv integer]);
FTP put command; Virtuoso FTP client
Returns true if XPATH extension function with the requested name is defined in the XPATH Processor, otherwise returns false.
array fvector ( elt1 , .... , elt-n );
return an array of either long, float or double
string generate-id ( place node_set);
Returns a string that uniquely identifies the node.
integer or string get_certificate_info (in typeinteger, in cert_or_key_namevarchar, in in_formatint, in passwdvarchar, in ext_oidvarchar);
Returns information about the current client X509 certificate
get_keyword ( keyword any, searched_array vector, [default any], [no_copy integer]);
Find a value in keyword vector
get_keyword_ucase ( keyword anything, searched_array vector, [default anything], [no_copy integer]);
Find a value in keyword vector (search uppercase)
returns the timestamp of the current transaction
returns the current transaction timestamp, alias of now
gt (in arg1any, in arg2any);
comparison functions
gte (inarg1 any, inarg2 any);
comparison functions
gz_compress (in str varchar);
Compress data using gzip algorithm
gz_uncompress (in str varchar, out str_out string_output);
Uncompress a string using gzip algorithm
hour (in dt datetime);
decompose a datetime to its components
hour (in dt datetime);
get hour from a datetime
http (in val_expr any, [in stream any]);
write to HTTP client or a string output stream
integer http_acl_get (in list_name varchar, in source_ip varchar, [in destination_ip_or_host varchar], [in object_id integer], [in read_write_flag integer]);
Test conditions against web server ACL's
Reads the HTTP body from the client HTTP connection and returns it as a string.
varchar http_client (in url varchar, [in uid varchar], [in pwd varchar], [in http_method varchar], [in http_headers varchar], [in body varchar], [in cert_file varchar], [in cert_pwd varchar]);
returns a varchar containing the body of the request uri
varchar http_client_ip ([in what integer]);
Returns the IP address of the calling client.
http_debug_log (in file_path varchar);
set WebDAV HTTP request logging
integer http_enable_gz (in mode integer);
Enable / Disable "Content-Encoding: gzip" for HTTP server
varchar http_file (in path varchar);
Send a file to the HTTP client
http_flush ([in try_what integer]);
Flush internal HTTP stream and disconnect client; Flush HTTP stream and try sending data in chunked mode.
varchar http_get (in target_uri varchar, [out return_header any], [in http_method varchar], [in request_header varchar], [in request_body varchar], [in proxy varchar]);
returns a varchar containing the body of the request uri
http_header (in head varchar);
Specifies non-default HTTP response headers
returns header of current HTTP request
http_kill (in client_IP_address varchar, in URL varchar, [in process_request_id integer]);
Kill VSP process whose details match parameter inputs
integer http_listen_host (in interface_address varchar, in action integer, [in options vector]);
Starts, stops and retrieves the state of a user-defined HTTP listener
http_map_get (in element_name varchar);
get values from HTTP virtual host path mapping table
http_map_table (in logical_path varchar, in physical_path varchar, in vhost varchar, in listen_host varchar, [in stored_in_dav integer], [in is_browseable integer], [in default_page varchar], [in security_restriction varchar], [in authentication varchar], [in auth_function varchar], [in postprocess_function varchar], [in execute_vsp_as varchar], [in execute_soap_as varchar], [in have_persistent_session_variables integer], [in soap_options any], [in auth_options any]);
Update internal HTTP mapping table
http_param ([in name varchar]);
returns value of a HTML form parameter in VSP context
returns the absolute path to the logical path location of the current http request
return array describing running VSP threads
returns the physical path location of the requested URL
http_proxy (in host varchar, in header any, in content varchar);
proxy request to another host and return content to calling client
http_request_get (in variable_name varchar);
Access to the HTTP request line
any http_request_header ([in array any], [in field_name varchar], [in attr-name varchar], [in default_value varchar]);
returns array of HTTP request header lines
http_request_status (in status_line varchar);
set the status sent to the client in an HTTP response
http_rewrite ([in stream any]);
Clears output written to a string output or to an HTTP
Returns the absolute path of the server root directory.
http_url (in val_expr any, [in tag varchar], [in stream any]);
write to HTTP client or string output stream with URL escapes
http_value (in val_exprany, [in tag varchar], [in stream any]);
write to HTTP client or string output stream with HTML escapes
http_xslt (in xslt_uri varchar, [in params any]);
applies an XSLT stylesheet to the output of a VSP page
sequence id ( ids any);
Returns an entities whose ID attributes are in the given list
returns the last assigned identity column value
any if ( test boolean, then_branch any, else_branch any);
If the boolean value is true then calculates one expression, otherwise calculates another expression.
any import_clr (in assemblies_vector any, in classes_vector any, [in security_mode integer]);
This function automatically creates the SQL Type wrappers based on the CLR Reflection API.
void import_jar (in files any, in classes any, [in security_mode integer]);
Creates SQL wrapper types of selected Java classes
initcap ( str string);
returns its argument with the first letter capitalized
internal_to_sql_type ( internal_type integer);
returns the integer standard SQL type of its argument
internal_type ( arg anything);
returns internal integer datatype of its argument
internal_type_name ( internal_type integer);
returns the internal type name of the argument
sequence intersect ( set1 sequence, set2 sequence);
Returns an intersect of two sets
boolean is_after() ( ent1 entity, ent2 entity);
Returns true if the given entity is after the second given entity in document order, otherwise returns false.
boolean is_before() ( ent1 entity, ent2 entity);
Returns true if the given entity is before the second given entity in document order, otherwise returns false.
Check for a valid array
boolean isbinary ( arg anything);
returns true if its argument is of type varbinary
isblob ( arg anything);
returns true if its argument is of type long varchar
isdouble ( arg anything);
returns true is argument is a double
returns true if its argument is an XML entity
isfloat ( arg anything);
returns true if its argument is a float
isinteger ( arg anything);
returns true if its argument is of type integer
isnull ( arg anything);
returns true if its argument is NULL
isnumeric ( arg anything);
returns true if argument is of numeric type
boolean isstring ( arg anything);
returns true if its argument is of type varchar
iszero ( arg any);
returns true if argument is numeric zero
java_call_method (in class_name varchar, in instance_obj varchar, in method_name varchar, in method_ret_sig varchar, [ arg1, ... ]);
java_get_property (in class_name varchar, in instance_obj varchar, in field_name varchar, in field_ret_type_sig varchar);
Gets a property value from a Java class instance.
java_load_class (in java_class_name varchar, in java_class_bytecode varchar);
Declares a Java class to a Java VM
any java_new_object (in class_name varchar, [in arg1 any], [ ... ]);
Creates and instance of a Java class.
java_set_property (in class_name varchar, in instance_obj any, in field_name varchar, in field_ret_type_sig varchar, in field_new_value any);
Sets a Java class property
java_vm_attach (in classpath varchar, [in vm_options any]);
Detaches the current Virtuoso working thread from the Java VM.
varchar jvm_ref_import (in files any, in classes any);
Creates XML description of Java class
string key ( keyname string, keyvalues any);
This XSLT 1.0 function is not implemented in the current version of Virtuoso.
boolean lang ( lang_name string);
Returns true if the language of context node matches given language name.
Returns the context size from expression evaluation context.
lcase ( str string);
Converts string argument to lower case
int ldap_add (in server_url varchar, in try_tls integer, in data varchar, in username varchar, in password varchar);
Adds a new entry to an LDAP directory.
int ldap_delete (in server_url varchar, in try_tls integer, in entrydn varchar, in username varchar, in password varchar);
Remove a leaf entry in the LDAP Directory Information Tree.
int ldap_modify (in server_url varchar, in try_tls integer, in data varchar, in username varchar, in password varchar);
Modifies an existing LDAP directory.
any ldap_search (in server_url varchar, in try_tls integer, in base varchar, in filter varchar, in username varchar, in password varchar);
Search in an LDAP server.
left ( str string, count integer);
returns substring taken from left of string argument
integer length (in arg any);
Get length of argument
any let ( var1name string, var1value sequence, var2name string, var2value sequence, ... , varNname string, varNvalue sequence, retval any);
Creates temporary variables and calculates an expression that uses these variables
WS.WS. LFS_EXP (in host varchar, in url varchar, in root varchar, in dst varchar);
Export retrieved web site to the local file system
lang_handler_t * lh_get_handler (const char *language_name );
Returns language handler
int lh_load_handler (lang_handler_t * new_handler );
Loads given handler in global table of the server
sequence list() ( seq1 sequence, seq2 sequence, ... , seqN sequence);
Selects the first item of every argument sequence and returns the sequence of the selected items
string local-name ([node_obj any]);
Returns the local part of the expanded name of the argument.
integer locate (in string_exp1 varchar, in string_exp2 varchar, [in start integer]);
returns the starting position of the first occurrence of an substring in a string
log (in x double precision);
calculate natural logarithm of an expression
log10 (in x double precision);
Calculate 10-based logarithms
log_enable (in flag integer);
controls transaction logging and in-statement autocommit
log_text (in text varchar, [in arg_1 any], [...]);
inserts statements into the roll forward log
lower ( str string);
returns a lower case version of its argument
lt (in arg1any, in arg2any);
comparison functions
lte (in arg1any, in arg2any);
comparison functions
ltrim ( str string, [trimchars string]);
removes specific characters from a string
array lvector ( elt1 , .... , elt-n );
return an array of either long, float or double
array make_array (in length integer, in content varchar);
returns a new array
make_string (in count integer);
make a string
number max ( arg1 any, arg2 any, ... , argN any);
Returns maximum value among all its arguments.
checksum md5 (in str varchar);
returns the md5 checksum of its argument
md5_final (in ctx varchar);
returns the md5 checksum given an initialized md5 context
returns the string serialization of a new md5 context
md5 context update md5_update (in ctx varchar, in data varchar);
returns the updated md5 context serialized as varchar
varchar mime_body (in mime_parts any);
used to compose multipart/mixed MIME message body
any mime_part (in content_type varchar, in content_disposition varchar, in transfer_encoding varchar, in data varchar);
used to compose a MIME message body part.
array mime_tree (in message_text string, [in flag integer ]);
parses MIME messages into an array structure
number min ( arg1 any, arg2 any, ... , argN any);
Returns minimum value among all its arguments.
minute (in dt datetime);
decompose a datetime to its components
minute (in dt datetime);
get minute from a datetime
mod ( dividend integer, divisor integer);
returns the modulus of its arguments
month (in dt datetime);
decompose a datetime to its components
month (in dt datetime);
get number of month from a datetime
monthname (in dt datetime);
decompose a datetime to its components
monthname (in dt datetime);
get name of month from a datetime
Get number of milliseconds from system epoch
mts_connect (in reconnect integer);
connects Virtuoso server to MS DTC.
returns timeout of distributed transaction in milliseconds.
mts_set_timeout (in timeout integer);
sets timeout of distributed transaction.
mts_status (in subject varchar);
checks status of current transaction or server.
string name ([node_obj any]);
Returns the expanded name of the argument.
varchar name_part (in string varchar, in idx integer);
Returns portion of dotted name such as a fully qualified table name.
string namespace-uri ( node_obj any);
Returns the namespace URI of the extended name of the given node
neq (in arg1any, in arg2any);
comparison functions
array nntp_auth_get (in server varchar, in user varchar, in password varchar, in command varchar, in group varchar, [in first_message integer], [in last_message integer]);
returns information about an NNTP server with authorization
array nntp_auth_post (in server varchar, in user varchar, in password varchar, in body varchar);
Post message to NNTP server with authorization
array nntp_get (in server varchar, in command varchar, in group varchar, [in first_message integer], [in last_message integer]);
Returns information about an NNTP server.
array nntp_post (in server varchar, in body varchar);
Post message to NNTP server
Returns the argument string with whitespace normalized.
boolean not ( obj boolean);
Returns true if its argument is false, and false otherwise.
returns the current transaction timestamp
number number ([obj any]);
Converts its argument to a number.
boolean or ( val1 boolean, val2 boolean, ... , valN boolean);
Returns true if a value of some argument is true, otherwise returns false.
os_chmod (in path varchar, in new_mod integer);
changes the file access mode of a file
os_chown (in path varchar, in username varchar, in groupname varchar);
changes the owning group/user of a file
pem_certificates_to_array (in pem_string varchar);
converts a PEM file to an array of PEM strings
trigonometric functions
any pldbg_stats ([in name varchar], [in add_line_info integer]);
Makes an array of line/count information based on current coverage.
pldbg_stats_load (in info any);
Used to load a coverage of a single procedure record as an array.
array pop3_get (in host varchar, in user varchar, in password varchar, in buffer_size integer, [in command varchar], [in exclude_uidl_list vector]);
get messages from a POP3 server
position ( element any, array any, start_index integer (optional, default 1), step integer (optional, default 1));
returns the index of an element within an array or string
Returns the context position from expression evaluation context.
power (in x double precision, in y double precision);
return value of expression raised to specified power.
any processXQuery ( module_uri string, [context entity], [index integer], [param1_name string], [param1_value any], ... [paramN_name string], [paramN_value any]);
Calls an XQuery module from XPath expression, e.g. from some XSLT or BPEL code.
entity processXSLT ( stylesheet_uri string, [source entity], [param1_name string], [param1_value any], ... [paramN_name string], [paramN_value any]);
Applies stylesheet to given XML entity and returns the result.
entity processXSQL ( xsql_page_uri string);
Executes XSQL page and returns the result.
prof_enable (in flag integer);
Control virtuoso profiling
prof_sample (in desc varchar, in time_spent integer, in flag integer);
Adds a profiling sample to a profile being accumulated.
any progn() ( expn1 any, expn2 any, ..., expnN any);
Calculates all given expressions and returns the result produced by the last one.
quarter (in dt datetime);
decompose a datetime to its components
quarter (in dt datetime);
get number of quarter of year from a datetime
varchar quote_dotted (in dsn varchar, in identifier varchar);
Returns an quoted identifier.
radians (in x double precision);
trigonometric functions
randomize (in seed integer);
initializes the random number generator
rclose (in cursor_handle long);
Closes cursor created by rexecute()
integer regexp_instr (in source_string varchar, in pattern varchar, [in start_position integer], [in occurrence integer], [in return_option integer], [in match_parameter integer]);
Returns the first position of the occurrence of a regular-expression pattern in a given string.
integer regexp_like (in source_string any, in pattern any, [in match_parameter integer]);
Allows a like comparison using regular-expression.
varchar regexp_match (in pattern any, inout str any, [in change_the_str integer]);
returns a substring matching the regular expression to the supplied string
index_vector regexp_parse (in pattern string, in target_string string, in offset integer);
returns substrings that match the regular expression in supplied string after an offset
varchar regexp_replace (in source_string any, in pattern any, [in replace_string varchar], [in position integer], [in occurrence any], [in match_parameter integer]);
Replaces occurrence(s) of the matching pattern in the source_string with a specified replace_string.
(varchar|nvarchar) regexp_substr (in pattern (varchar|nvarchar), in str (varchar|nvarchar), in offset integer);
returns a single captured substring from matched substring
varchar registry_get (in name varchar);
Returns a current value of a registry setting
Returns a vector of all registry settings
The function checks if a given registry variable is read-only or protected from occasional changes.
registry_remove (in name varchar);
Remove a vriable from registry
registry_set (in name varchar, in value varchar, [in force integer]);
Associates a value to the name in the Database registry
numeric REGR_AVGX (in expr1 any, in expr2 any);
Evaluates the average of the independent variable (expr2) of the regression line.
numeric REGR_AVGY (in expr1 any, in expr2 any);
Evaluates the average of the independent variable (expr1) of the regression line.
numeric REGR_COUNT (in expr1 any, in expr2 any);
Returns the number of non-null numbers used to fit the regression line.
numeric REGR_INTERCEPT (in expr1 any, in expr2 any);
Returns the y-intercept of the regression line.
numeric REGR_R2 (in expr1 any, in expr2 any);
Returns the coeffient of determination (R-squared) of the regression line.
numeric REGR_SLOPE (in expr1 any, in expr2 any);
Returns the slope of the line.
numeric REGR_SXX (in expr1 any, in expr2 any);
Auxiliary function used to compute various diagnostic statistics.
numeric REGR_SXY (in expr1 any, in expr2 any);
Auxiliary function used to compute various diagnostic statistics.
numeric REGR_SYY (in expr1 any, in expr2 any);
Auxiliary function used to compute various diagnostic statistics.
repeat (in str string, in count integer);
returns a new string consisting of its string argument repeated a given number of times
None REPL_ADD_CR (in tbl varchar, in name_suffix varchar, in type char, in order integer, in class varchar, in col varchar);
Creates conflict resolver for bi-directional transactional replication
None REPL_ADD_DAV_CR (in col varchar, in name_suffix varchar, in order integer, in class varchar);
Creates conflict resolver for bi-directional replication in DAV
None REPL_ADD_SNAPSHOT_CR (in tbl varchar, in name_suffix varchar, in type char, in order integer, in class varchar, in col varchar);
Creates conflict resolver for bi-directional replication
None REPL_CREATE_SNAPSHOT_PUB (in item varchar, in type integer);
Create bi-directional snapshot publication
None REPL_CREATE_SNAPSHOT_SUB (in server varchar, in item varchar, in type integer);
Create bi-directional snapshot subscription to an existing publication.
repl_disconnect (in publisher varchar);
terminates communication with a replication publisher
None REPL_DROP_SNAPSHOT_PUB (in item varchar, in type integer);
Drop bi-directional snapshot publication
None REPL_DROP_SNAPSHOT_SUB (in server varchar, in item varchar, in type integer);
Drops a subscription to a bi-directional snapshot publication
REPL_GRANT (in publication varchar, in grantee varchar);
grant privileges for subscription to a publication
REPL_INIT_COPY (in server_name varchar, in publication varchar);
create initial subscription state
None REPL_INIT_SNAPSHOT (in server varchar, in item varchar, in type integer, [in how_many integer]);
Initializes a bi-directional snapshot publication
repl_new_log (in publication varchar, in file varchar);
create new publication log
REPL_PUB_ADD (in publication varchar, in item varchar, in type integer, in mode integer, in procedure_replication_options integer);
add item to a publication
REPL_PUB_INIT_IMAGE (in publication varchar, in image_file_path varchar, in bytes_per_file integer);
create initial image of publication on publisher
REPL_PUB_REMOVE (in publication varchar, in item varchar, in type integer, in flag integer);
remove item from publication.
REPL_PUBLISH (in publication varchar, in log_path varchar, [in is_updateable integer], [in sync_user varchar]);
create publication on publisher
repl_purge (in server varchar, in account varchar);
purges transactional replication logs for specified account
REPL_REVOKE (in publication varchar, in grantee varchar);
revoke privileges for subscription
adds scheduled job to synchronize subscriptions
REPL_SERVER (in server_name varchar, in dsn varchar, in replication_address varchar);
defines a server that will participate in replication
Return bi-directional snapshot replication server name for specified DSN
repl_server_rename (in old_namevarchar, in new_namevarchar);
rename the publishing server instance
varchar REPL_SNP_SERVER (in dsn varchar, in uid varchar, in pwd varchar);
Define bi-directional snapshot replication server name
retrieve status of all subscriptions and publications
repl_status (in publisher varchar, in publication varchar, out level integer, out stat integer);
returns status of a published or subscribed publication
REPL_SUBSCRIBE (in server_name varchar, in publication varchar, in dav_user varchar, in dav_group varchar, in replication_user varchar, in replication_password varchar, [in sync_user varchar]);
add a subscription
repl_sync (in publisher varchar, in publication varchar, in uid varchar, in password varchar);
starts the syncing process against an existing subscription
synchronize all subscriptions
repl_text (in publication varchar, in sqltext varchar, in a-1 any, ... );
adds a SQL statement to the log of the replication
returns calling servers name
REPL_UNPUBLISH (in publication varchar);
drop publication on publisher
REPL_UNSUBSCRIBE (in server_name varchar, in publication varchar, in item varchar);
drop subscription
None REPL_UPDATE_SNAPSHOT (in item varchar, in type integer);
Updates a bi-directional snapshot publication
string replace (in string varchar, in what varchar, in repl_with varchar);
This replaces every occurrence of the second argument in the first argument with the third argument.
string replace() ( txt string, search_strg string, replace_strg string);
Searches for an substring and replace its occurences with other substring.
replay (in log_file varchar);
starts the roll forward of the given log
result (in col_1 any, .. , in col_n any);
Sends one row of results to the calling client.
result_names (in var_1 , ... , in var_n );
rexecute (in dsn varchar, in sql_stmt varchar, out sql_state varchar, out error_message varchar, in in_params vector, out num_cols integer, out stmt_meta vector, out result_set vector, out cursor_handle long);
execute a SQL statement on a remote DSN
right (in str string, in count integer);
get n rightmost characters of a string
rmoreresults (in cursor_handle long, out sql_state varchar, out sql_error varchar, out num_cols integer, out stmt_meta vector);
move to next result set of rexecute()
number rnd (in n integer);
returns a random number between 0 and n - 1 inclusive
integer retcode rnext (in cursor_handle long, out row_array vector, out sql_state varchar, out sql_error varchar);
Get next result from a remote result set
integer round ( num number);
Returns the integer that is the nearests to the argument.
returns number of rows affected by the previous DML statement in a procedure body
rstmtexec (in dsn varchar, in stmt varchar, [in max_rows integer], [in params_array vector]);
execute a SQL statement on a remote DSN, provides a result set where applicable.
rtrim ( str string, [trimchars string]);
trims given characters from right of given string
search_excerpt (in hit_words any, in text varchar, [in within_first int], [in max_excerpt int], [in total int], [in html_hit_tag varchar]);
Returns excerpts with hit words from text
second (in dt datetime);
decompose a datetime to its components
second (in dt datetime);
get second from a datetime
Returns a vector of states of all sequence objects
integer sequence_next (in name varchar, in increment_by integer);
Returns the current state of the specified sequence and increments it by one.
sequence_remove (in name varchar);
Removes a requece object
integer sequence_set (in name varchar, in state integer, in mode integer);
Sets and returns the state of a sequence object.
convert any heterogeneous array or tree of arrays into a binary string and back
Serializes a value of its argument following the rules of the host RDBMS.
Converts argument to its UTF-8 string representation.
WS.WS. SERV_QUEUE_TOP (in target varchar, in WebDAV_collection varchar, in update integer, in debug integer, in function_hook varchar, in data any);
Retrieve target website and store within Virtuoso
session_handle ses_connect (in host_and_port varchar);
Opens a TCP session and returns its handle.
ses_disconnect (in ses ses_handle);
Disconnections a TCP session.
varchar ses_read_line ([in ses any], [in throw_exception_on_eof integer], [in binary_modeinteger ]);
Read a line of character data from a TCP session.
ses_write (in buffer varchar, [in ses session_handle]);
Write character data to an open TCP session.
integer set_identity_column (in table_name varchar, in column_name varchar, in new_value integer);
sets the sequence starting value for an identity column
integer set_row_count (in increment integer, [in what integer]);
sets the affected rows counter in the current context or in the context of the caller
integer set_user_id (in user_name varchar, in mode integer, in password varchar);
sets the current user for execution
entity shallow ( ent entity);
Returns a shallow copy of the given XML entity
sign ( num numeric);
returns -1, 0, or 1 depending on the sign of its numerical
signal (in sqlstate varchar, in message varchar);
Signal an exception in the calling procedure
sin (in x double precision);
trigonometric functions
sinv_create_inverse (in _SINVM_NAME_IN varchar, in _SINV_INVERSE any, in _SINVM_FLAGS integer);
Creates inverse mapping for the mentioned functions (as described in the doc section SQL Inverse Functions).
sinv_create_key_mapping (in map_name varchar, in part_defs any, in do_drops integer := 1);
Creates a key mapping function & table (as described in the doc section SQL Inverse Functions).
sinv_drop_inverse (in _SINVM_NAME_IN varchar);
Reverses the effect of sinv_create_inverse procedure.
varchar smime_sign (in msg_text varchar, in signer_cert varchar, [in private_key varchar], [in private_key_pass varchar], [in signer_CA_certs any], [in flags integer]);
Converts a MIME message to a signed S/MIME message
varchar smime_verify (in msg_text varchar, in certs any, [out signer_certs any], [in flags integer]);
Verifies signature of signed MIME message
smtp_send (in server string, in sender string, in recipient string, in body string);
send message to SMTP server
any soap_box_structure (in elem1 varchar, in value1 any, in ... , in elem1 varchar, in value1 any);
any soap_box_xml_entity (in entity any, in try_typed_as any, [in soap_version integer]);
Converts an XML entity to an SQL value given the desired SQL type.
any soap_call (in host string, in path string, in methodURI string, in methodName string, in params array of (ParamName, Value), in version integer, in certificate varchar, in password varchar, in SOAPAction varchar);
calls a function from a SOAP server and returns the result. value; deprecated, use SOAP_CLIENT () instead
soap_client (in url varchar, in operation varchar, in target_namespace varchar default null, in parameters any default null, in headers any default null, in soap_action varchar default '', in attachments any default null, in ticket any default null, in passwd varchar default null, in user_name varchar default null, in user_password varchar default null, in auth_type varchar default 'none', in security_type varchar default null, in debug integer default 0, in template varchar default null, in style integer default 0, in version integer default 11, in direction integer default 0, in http_header varchar default null, in security_schema any default null, in time_out int default 100);
Invoke a SOAP service and returns result value.
Returns URL used to access particular HTTP resource.
soap_dt_define (in namevarchar, in schema_stringvarchar);
define re-define or erase the complex datatype definition for SOAP calls
varchar soap_make_error (in soap_code varchar, in sql_state varchar, in error_message varchar, [in soap_version integer], [in do_uddi integer]);
Creates a SOAP error reply XML message based on its parameters.
soap_print_box (in value any, in enclosing_tag varchar, [in date_encoding_type|soap_version integer]);
Formats an SQL value and returns it as a generated XML fragment.
soap_sdl (in module_name varchar, [in URL varchar]);
Generate SDL document for a PL module and return it as a varchar.
varchar soap_server (in req_xml any, [in soap_method varchar], [in lines any], [in soap_version long], [in procedure_mappings any]);
Execute SOAP request and return XML reply as a varchar.
varchar soap_wsdl (in module_namevarchar, [in URLvarchar]);
Generate WSDL document for a PL module and return it as a varchar.
array DB.DBA. SOAP_WSDL_IMPORT (in target_url varchar);
boolean some ( varname string, test_set sequence, test_expn boolean);
Returns true if at least one item of given sequence matches given criterion.
space (in count integer);
returns a new string of count spaces
vector or string split_and_decode (in coded_str varchar, [in case_mode integer], [in str varchar]);
converts escaped var=val pairs to a vector of strings
sprintf ( format string, arg_1 any, ... , arg_x any);
returns a formatted string
any sql:column (constant column_name varchar);
Returns the value of a column from SQL result-set.
vector sql_columns (in dsn varchar, in qualifier varchar, in owner varchar, in table_name varchar, in column varchar);
get column information from table on a remote DSN
vector sql_config_data_sources (in driver varchar, in type varchar, in attrib varchar);
Configures a remote DSN as in the DSN attribute string
get list of available DSNs
integer sql_driver_connect (in conn_str varchar);
Tries connecting using supplied connection string
get column information from table on a remote DSN
vector sql_get_private_profile_string (in dsn varchar, in type varchar);
Gets the DSN's attributes list
vector sql_gettypeinfo (in dsn varchar, in type integer);
return type information from a remote DSN
vector sql_primary_keys (in dsn varchar, in qualifier varchar, in owner varchar, in table_name varchar);
get primary key information about a table on a remote DSN
vector sql_procedures (in dsn varchar, in qualifier varchar, in owner varchar, in name varchar);
get procedures information for a remote DSN
vector sql_remove_dsn_from_ini (in dsn varchar, in dsn_type varchar);
removes a DSN from the ODBC registry
vector sql_special_columns (in dsn varchar, in qualifier varchar, in owner varchar, in table_name varchar, in scope integer, in nullable integer);
get special column information from table on a remote DSN
vector sql_statistics (in dsn varchar, in qualifier varchar, in owner varchar, in table_name varchar, in is_unique integer, in detail integer);
retrieve statistics information on remote DSN
vector sql_tables (in dsn varchar, in qualifier varchar, in owner varchar, in table_name varchar, in tabletype varchar);
get list of tables from remote DSN
sql_transact (in dsn_name varchar, [in rollback integer]);
get list of available DSNs
integer sql_write_file_dsn (in dsn varchar, in string varchar, in value varchar);
Creates a new file DSN
integer sql_write_private_profile_string (in dsn varchar, in type varchar, in name varchar, in value varchar);
Sets a DSN's attribute value
sqrt (in x double precision);
calculate square root
boolean starts-with ( strg string, prefix string);
Returns true if the first argument string starts with the second argument string, and otherwise returns false.
status ([in option varchar]);
Returns statistics for a running server as a result set
numeric STDDEV (in expr1 any, in expr2 any);
Returns the standard deviation.
numeric STDDEV_POP (in expr any);
Returns the population standard deviation.
Returns the cumulative sample standard deviation.
strcasestr (in str string, in sub string);
case-insensitive substring search
strchr ( str string, char string or integer);
strchr returns a zero-based index to the first occurrence of the character.
string string ([obj any]);
Returns a string value of its argument.
integer string-length ([strg string]);
Returns the number of characters in the string.
string_output ([in threshold integer]);
make a string output stream
string_output_flush (inout streamany);
resets the state of the string_output object
string_output_gz_compress (in str_out_in string_session, out str_out_out string_session);
compress a string_output with gzip algorithm
string_output_string (in string_out any);
produce a string out of a string output stream
string_to_file (in path varchar, in string varchar, in mode integer);
writes a varchar to a file
stringdate (in str varchar);
Convert a string to a datetime
time stringtime (in str varchar);
converts string to a time
strrchr ( str string, char string or integer);
returns a zero-based index to the last occurrence of the char in str.
strstr (in str string, in sub string);
substring search
sub_schedule (in server_name varchar, in publication varchar, in interval integer);
add scheduled job for periodic synchronization of a subscription
subseq ( str string or vector , from integer, [to integer or NULL]);
returns substring of a string or sub-vector of a vector
substring ( str string, from integer, sublen integer);
returns a substring of a string
string substring ( strg string, start integer, [length integer]);
Returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument.
string substring-after ( source_strg string, sub_strg string);
Returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string.
string substring-before ( source_strg string, sub_strg string);
Returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string.
number sum ( arg1 any, arg2 any, ... , argN any);
Returns sum of all its arguments
SYS_DB_STAT (in pcnt integer, in ignore_vdb integer);
gathers common statistical information about the database.
sys_lockdown (in lock_action integer, [in listeners_mode integer]);
Set virtuoso in lockdown state and back.
any sys_stat (in stat_name varchar);
Return statistical information about the Virtuoso server.
sys_stat_analyze (in table_name varchar, [in pcnt integer], [in ignore_vdb integer]);
Collects statistics on a table and its columns for use in SQL optinmization
sys_stat_histogram (in table_name varchar, in column_name varchar, in n_buckets integer, [in prec integer]);
Collects a column value histogram for use in SQL optimization
system (in command varchar);
runs a shell command from SQL
object system-property ( property_qname varchar);
Returns a value of the system property identified by the name
table_drop_policy (in _tb varchar, [in _type varchar]);
Drops policy function from table.
table_set_policy (in tablename varchar, in policypl varchar, [in policy_scope varchar]);
Sets policy function to table.
tan (in x double precision);
trigonometric functions
varchar tcpip_gethostbyaddr (in address varchar);
Returns fully qialified DNS name of the host associated with given IP address
Returns IP address by host domain name
boolean text_contains() ( scope node-set, query string);
Returns true if the text value of some node in the given node-set contains the text matching the given free-text query, otherwise returns false.
tidy_html (in raw_html varchar, in tidy_config varchar);
Invoke built-in version of HTML Tidy utility to fix typical errors in HTML text
tidy_list_errors (in raw_html varchar, in tidy_config varchar);
Invoke built-in version of HTML Tidy utility to get list of errors in given input HTML text
timezone (in dt datetime);
decompose a datetime to its components
timezone (in dt datetime);
get timezone difference from a datetime
varchar tmp_file_name (in prefix varchar, in suffix varchar);
returns the unique file name within temporary directory of the operating system
integer trace_off (in parameter varchar);
Disable extra logging for Virtuoso server
integer trace_on (in parameter varchar);
Enable extra debug logging
show current trace settings
string translate ( strg string, search_list string, replace_list string);
Prforms char-by-char translation of given string
string tree_md5 (in tree any);
returns MD5 checksum of array argument
trim ( str string, [trimchars string]);
removes characters from both ends of string argument
Returns true
sequence tuple() ( seq1 sequence, seq2 sequence, ... , seqN sequence);
Selects the first item of every argument sequence and returns the sequence of the selected items
txn_error (in code integer);
poison current transaction forcing rollback
txn_killall (in code integer);
kill all pending transactions
ucase ( str string);
returns upper case version of string argument
uddi_delete_binding Causes one or more bindingTemplate structures to be deleted.
uddi_delete_business Remove one or more businessEntity structures.
uddi_delete_service Remove one or more businessService structures.
uddi_delete_tModel Remove or retire one or more tModel structures.
uddi_discard_authToken Inform a UDDI server that the authentication token can be discarded.
uddi_find_binding Retrieves matching bindings
uddi_find_business Retrieves a businessList message matching supplied criteria.
uddi_find_service Retrieves serviceList message matching search criteria
uddi_find_tModel locate list of tModel entries matching supplied criteria
uddi_get_authToken Obtain authentication token.
uddi_get_bindingDetail Request run-time bindingTemplate location information.
uddi_get_businessDetail returns complete businessEntity information for one or more specified businessEntities
uddi_get_businessDetailExt Returns extended businessEntity information for one or more specified businessEntities.
uddi_get_registeredInfo Retrieve an abbreviated list of all businessEntity keys.
uddi_get_serviceDetail request full information about a known businessService structure
uddi_get_tModelDetail Request full information about a known tModel structure.
uddi_save_binding save or update a complete bindingTemplate structure
uddi_save_business Save or update information about a complete businessEntity structure.
uddi_save_service Adds or updates one or more businessService structures.
uddi_save_tModel Adds or updates one or more tModel structures.
integer udt_defines_field (in udt any, in member_name varchar);
Determines whether a user defined type contains a specified member.
any udt_get (in udt_inst any, in member_name varchar);
Retrieves a copy of the requested member from a user defined type instance
any udt_implements_method (in udt any, in method_name varchar);
provides a handle to the first method with specific name in a user defined type.
integer udt_instance_of (in udt1 any, in udt2 any);
returns the type name of supplied type or compares two input types.
udt_set (in udt_inst any, in member_name varchar, in new_value any);
any unimport_clr (in assemblies_vector any, in classes_vector any);
This function automatically drops the SQL Type wrappers based on the CLR Reflection API.
void unimport_jar (in files any, in classes any);
Drops SQL wrapper types of selected Java classes
sequence union ( set1 sequence, set2 sequence, ... setN sequence);
Returns an union of two or more sets
sequence unordered ( input sequence);
Returns the given sequence in any order.
string unparsed-entity-uri ( unparsed_entity_name string);
This XSLT 1.0 function is not implemented in the current version of Virtuoso.
any updateXML (in source any, in path1 varchar, in replacement1 any, in path2 varchar, in replacement2 any, ... , in pathN varchar, in replacementN any);
Create a changed copy of given document by replacing some nodes.
upper ( str string);
returns upper case version of string argument
string urlify ( obj string);
Converts its argument to a string and returns it in URL encoding.
USER_CHANGE_PASSWORD (in name varchar, in old_pwd varchar, in new_pwd varchar);
Change the password of an existing user account.
USER_CREATE (in name varchar, in password varchar, in options vector);
create a new user account
USER_DROP (in name varchar, in cascade integer);
This deletes a user ccount, optionally including schema objects, DAV resources and other possible resources owned by the user.
USER_GET_OPTION (in name varchar, in opt varchar);
Retrieve a user option for a given user account.
USER_GRANT_ROLE (in name varchar, in role varchar, in grant_opt int);
Assign an existing role to an existing security object.
USER_REVOKE_ROLE (in name varchar, in role varchar);
Removes a role from an existing security object.
USER_ROLE_CREATE (in name varchar);
create a new SQL role. Same as the create role statemen..
USER_ROLE_DROP (in name varchar);
Remove an existing role (group).
USER_SET_OPTION (in name varchar, in opt varchar, in value any);
Set a user option for a given user account.
user_set_password (in user_name string, in new_password string);
Allows dba to change a user's password.
USER_SET_QUALIFIER (in name varchar, in qual varchar);
Change the default catalog (qualifier/database) of a user account.
returns the login name of the current user
uudecode (in input string, in mode integer);
Decodes a string previously encoded by uuencode
uuencode (in input string or string session, in mode integer, in maxlines integer);
Encodes string or string session into sequence of printable characters, suitable for transfer via "ASCII-only" data channels
uuvalidate (in input string or string session, in mode integer);
Encodes string or string session into sequence of printable characters, suitable for transfer via "ASCII-only" data channels
array DB.DBA. VAD_CHECK (in package_name varchar);
Checks the package has not been altered since installation
Checks the presence and correct versions of required packages and of the Virtuoso platform
Checks if the package can be uninstalled.
DB.DBA. VAD_FAIL_CHECK (in msg varchar);
Signals package check failure
varchar DB.DBA. VAD_INSTALL (in package_uri varchar, in source_type integer);
Invoke VAD installation process
DB.DBA. VAD_LOAD_FILE (in fname varchar);
executes statements of a SQL file
varchar DB.DBA. VAD_PACK (in sticker_uri varchar, in base_uri_of_resources varchar, in package_uri varchar);
get VAD resource
DB.DBA. VAD_SAFE_EXEC (in expr varchar);
execute without signalling errors
varchar DB.DBA. VAD_UNINSTALL (in package_name varchar);
Vad package uninstallation
numeric VAR (in expr any);
Returns the variance.
numeric VAR_POP (in expr any);
Returns the population variance.
numeric VAR_SAMP (in expr any);
Returns the sample variance.
vd_remote_data_source (in dsn varchar, in connstr varchar, in user varchar, in password varchar);
prepares a remote DSN for use
varchar vd_remote_proc_wrapper (in dsn varchar, in remote_name varchar, in local_name varchar, in metadata any, out status_code varchar, out error_message varchar, in make_resultset integer, in description varchar);
Creating a PL wrapper for remote procedure execution
vd_remote_table (in dsn varchar, in local_name varchar, in remote_name varchar);
declares an existing table as resident on a DSN previously declared with vd_remote_data_source
DB.DBA. VD_STATISTICS ([in _dsn varchar], [in vd_table_mask varchar]);
Update VDB RPC cost statistics for given DSN
Disconnects a data source if no active transactions are using resources from it.
Estimate VDB RPC round-trip for a given DSN in milliseconds
vector ( elem1 any, elem2 any, ... , elem-n any);
make a vector
vector vector_concat ( vec1 vector, vec2 vector, ... , vec-n vector);
concatenate vectors
Void DB.DBA. VHOST_DEFINE (in vhost varchar, in lhost varchar, in lpath varchar, in ppath varchar, in is_dav boolean, in is_brws boolean, in def_page varchar, in auth_fn varchar, in realm varchar, in ppr_fn varchar, in vsp_user varchar, in soap_user varchar, in sec varchar, in ses_vars boolean, in soap_opts any, in auth_opts any, in opts any, in is_default_host integer);
define a virtual host or virtual directory
Void DB.DBA. VHOST_REMOVE (in vhost varchar, in lhost varchar, in lpath varchar, in del_vsps integer);
remove a virtual host or virtual directory
Return full name of configuration INI file
vsp_calculate_digest (in username varchar, in password varchar, in credentials any);
calculate on server-side a digest to perform a HTTP digest authentication
Returns a vt batch object.
vt_batch_d_id (in d_id any);
Specify a document to update in a vt batch.
vt_batch_feed (in vt_batch any, in text_or_xml any, in is_del integer, [in is_xml integer]);
Add words to a free text update batch.
vt_batch_feed_offband (in vt_batch any, in clustered_values string, in is_del integer);
Add offband information to a free text update batch.
integer DB.DBA. VT_BATCH_UPDATE (in table varchar, in flag varchar, in interval_minutes integer);
Set batch mode update of free text indexing.
vt_create_text_index (in table varchar, in col varchar, in id_col varchar, in is_xml integer, in defer_generation integer, in clustered_columns any, in use_hook_function integer, [in language_name varchar], [in encoding_name integer]);
Add text index to an existing table
DB.DBA. VT_DROP_FTT (in target_table_name varchar, in opt_data_column or NULL varchar);
drop free text trigger
vt_is_noise (in word varchar, in encoding varchar, in language varchar);
determines whether input is a noise word
week (in dt datetime);
decompose a datetime to its components
week (in dt datetime);
get number of week from a datetime
varchar WSDL_IMPORT_UDT (in url varchar, in f varchar, in exec any);
Returns a string containing a UDT definition
token wst_cli (in req soap_client_req, in policy any);
Request a security token from WST endpoint
varchar x509_certificate_verify (in cert varchar, in cacerts any, [in flags varchar]);
Verifies X.509 certificate
varchar xenc_decrypt_soap (in xml_text varchar, in soap_version int, in validate_flag int, in encoding varchar, in lang varchar, in opts any, out keys any);
Decrypt and verify a SOAP message
Remove the temporary keys from user's space
varchar xenc_encrypt (in message varchar, in soap_ver int, in template varchar, in ns any, in xp-n varchar, in ki-n any, in what-n varchar, ... );
Encrypt and optianally sign a SOAP message
varchar xenc_get_key_algo (in key_name varchar);
Determine XML signature algorithm of a key
Determine a key identifier
xenc_key_3DES_create (in name varchar, in secret varchar);
Used to make a symmetric key.
Used to make a temporary session key.
xenc_key_3DES_read (in name varchar, in key_data varchar);
Importing a tripple-des key into user's repository
xenc_key_AES_create (in name varchar, in bits int, in secret varchar);
Used to make a symmetric key.
xenc_key_AES_rand_create (in name varchar, in bits int);
Used to make a temporary session key.
xenc_key_create_cert (in name varchar, in cert varchar, in type varchar, in fmt int, in pkey varchar, in pass varchar);
Import a key from a certificate
xenc_key_DSA_create (in name varchar);
Used to make asymmetric DSA key.
xenc_key_DSA_read (in name varchar, in key_data varchar);
Importing a DSA key into user's repository
int xenc_key_exists (in name varchar);
Check if named encryption key is in the user's repository
any xenc_key_inst_create (in name varchar, in super any);
Key instance generation
xenc_key_remove (in key_name varchar);
This will delete a key from current user's space.
xenc_key_RSA_read (in name varchar, in key_data varchar);
Importing a RSA key into user's repository
varchar xenc_key_serialize (in name varchar, in public int);
Extracts a key from user's repository
xenc_set_primary_key (in name varchar);
Associate a X.509 certificate with a key
Exports a X.509 certificate from user's repository
xml_add_system_path (in pathvarchar);
Adds path to the internal list of system paths.
xml_auto (in sql_text varchar, in params any, [in string_output any]);
prepares and executes given SQL for XML string output
varchar xml_auto_dtd (in query varchar, in root_element varchar);
returns an XML DTD for the result of a SQL query with a FOR XML clause
varchar xml_auto_schema (in query varchar, in root_element varchar);
returns an XML schema for the result of an SQL query with a FOR XML clause
xml_create_tables_from_mapping_schema_decl (in base_uri varchar, in mapping_schema_file varchar, in content_encoding varchar, in content_language varchar);
returns a vector containing strings. Each string is a command to drop a table or a foreign key or to create table.
xml_cut (in source_entity any (XML entity));
creates a new XML document which contains a copy of data pointed by given XML tree- or XPER- entity
varchar xml_doc_output_option (in xml_entity any, in option_name varchar, [in option_value varchar]);
Returns vector of all system paths.
xml_load_mapping_schema_decl (in base_uri varchar, in mapping_schema_file varchar, in content_encoding varchar, in content_language varchar);
creates a xml view from mapping schema.
xml_load_schema_decl (in base_uri varchar, in document_uri varchar, in content_encoding varchar, in content_language varchar);
returns a string with list of errors detected by XML Schema processor on reading given XML Schema definition document.
vector xml_namespace_scope (in ent XML Entity, in use_default_ns integer);
Returns a vector of all namespace declarations in all ancestors of the given XML entity.
xml_persistent (in document varchar, [in parser_mode integer], [in base_uri varchar], [in content_encoding varchar], [in content_language varchar], [in dtd_validator_config varchar]);
returns an entity object ('XPER entity') created from given XML document
xml_template (in xml_document_entity any, in parameters vector, [inout session string_session]);
Execute XML template from Virtuoso PL
xml_tree (in document varchar, [in parser_mode integer], [in base_uri varchar], [in content_encoding varchar], [in content_language varchar], [in dtd_validator_config varchar]);
Parses an XML fragment and returns the parse tree as nested vectors.
xml_tree_doc (in tree any, [in base_uri varchar]);
returns an entity object given a tree from xml_tree
varchar DB.DBA. xml_uri_get (in base varchar, in ref varchar);
Retrieve a resource based on a URI
xml_validate_dtd (in document varchar, in parser_mode integer, in base_uri varchar, in content_encoding varchar, in content_language varchar, in dtd_validator_config varchar);
returns a string with list of errors detected by DTD validator on reading given XML document
xml_validate_schema (in document varchar, in parser_mode integer, in base_uri varchar, in content_encoding varchar, in content_language varchar, in dtd_validator_config varchar);
returns a string with list of errors detected by DTD and XML Schema validator on reading given XML document.
varchar xml_view_dtd (in view_namevarchar, in root_elementvarchar);
returns an XML DTD for the output of given XML VIEW
varchar xml_view_schema (in query varchar, in root_element varchar);
returns an XML schema for the output of given XML VIEW
integer XMLAddAttribute (inout source any, in mode integer, in attr_name any, [in attr_value any]);
Add an attribute to the given node of an XML tree document
vector XMLAGG ( value_expression any);
Produces a forest of elements from a collection of XML values
XMLAppendChildren (inout source any, in insertion1 any, in insertion2 any, ... , in insertionN any);
Modify an XML document by adding new children to the given entity.
XMLATTRIBUTES ( string_expr1 [AS alias1] varchar, [string_expr2 [AS alias2] varchar], [...], [string_exprN [AS aliasN] varchar]);
Creates a list of attributes and their values
XMLCONCAT ( value_expr1 varchar, [value_expr2 varchar], [...], [value_exprN varchar]);
Creates a forest of elements by concatenating a list of XML values
XMLELEMENT ( tag_name varchar, [list_of_attributes sequence], [child_or_attribute1 any], [child_or_attribute2 any], [...], [child_or_attributeN any]);
Creates XML element
XMLFOREST ( string_expr1 [AS alias1] varchar, [ string_expr2 [AS alias2] varchar ], [ ... ], [ string_exprN [AS aliasN] varchar ]);
Produces a forest of XML elements
XMLInsertAfter (inout source any, in insertion1 any, in insertion2 any, ... , in insertionN any);
Modify an XML document by inserting new children after the node specified by given entity.
XMLInsertBefore (inout source any, in insertion1 any, in insertion2 any, ... , in insertionN any);
Modify an XML document by inserting new children before the node specified by given entity.
any XMLReplace (inout source any, in location1 any, in replacement1 any, in location2 any, in replacement2 any, in ... , in locationN any, in replacementN any);
Modify a given XML document by replacing some nodes.
xmlsql_update (in xml_gramsXML_Entity , [in input_parameters vector], [in debug integer]);
Performs insert/update/delete operations based on an XML updategram.
structure xmlStorageSystem.deleteMultipleFiles (in email string, in password string, in relativepathList array);
Remove files from XML Storage System Directory
structure xmlStorageSystem.getServerCapabilities (in email string, in password string);
Retrieve server specific information.
Mail password to user.
structure xmlStorageSystem.registerUser (in email string, in name string, in password string, in clientPort integer, in userAgent string, in serialNumber string);
Register a user with the XML Storage System
structure xmlStorageSystem.saveMultipleFiles (in email string, in password string, in relativepathList array, in fileTextList array);
Upload a set of files to XML Storage System directory.
Returns a copy of the given instance with the schema reference removed.
XMLType.createSchemaBasedXML ([in schema_url varchar]);
Returns a copy of the given instance with new schema reference.
static method XMLType.createXML (in src any, [in schema_uri varchar], [in validated integer], [in wellformed any]);
Creates an XML Type instance.
XMLType.existsNode (in xpath_expn varchar, [in namespace_map varchar]);
Tests node existance having evaluated given XPATH expression.
XMLType.extract (in xpath_expn varchar, [in namespace_map varchar]);
Evaluates given XPATH expression.
This function returns the serialization of the current node like XPATH function 'serialize()', i.e. a text in XML syntax.
Returns the namespace of the top level element providing the instance is schema-based rather than a fragment.
This function returns the integer-value of the current node like XPATH function 'number()'.
Returns top-level element of the given instance (NULL for fragment)
Returns the URL of the XML schema definition for schema based instances, NULL for non-schema based.
The function returns the string-value of the current node like XPATH function 'string()'.
The function returns 1 if the instance is an XML generic entity or 0 if it is a plain document.
Returns 1 if the given XMLType instance is schema-based, otherwise returns 0.
XMLType.isSchemaValid ([in schema_url varchar], [in top_element_name varchar]);
Validates the given XMLType instance against an arbitrary XML schema, returns 1 if successful, 0 if errors are detected.
Returns 1 or 0 indicating if the XML entity has been validated against the associated schema.
Validates the schema based XMLType instance against its schema and signals an error in case of failed validation.
XMLType.setSchemaValidated ([in flag integer default 1]);
Changes the internal "is validated" flag of the given XMLType instance.
XMLType.toObject ([in schema varchar], [in element varchar]);
XMLType.transform ( stylesheet XMLType, [params_map vector]);
contructor method XMLType.XMLType (in src any, [in schema_uri any], [in validated any], [in wellformed any]);
any XMLUpdate (inout source any, in path1 varchar, in replacement1 any, in path2 varchar, in replacement2 any, ... , in pathN varchar, in replacementN any);
Create a changed copy of given document by replacing some nodes.
xmlview (in view_name varchar);
Returns the xml document corresponding to given XML view
xpath_eval (in xpath_expression varchar, in xml_tree XML Entity, [in index integer], [in named_params vector]);
Applies an XPATH expression to a context node and returns result(s).
xper_cut (in source_xperXML_Entity);
creates a new "persistent XML"document which contains a copy of data pointed by given XPER entity
xper_doc (in document varchar, [in parser_mode integer], [in base_uri varchar], [in content_encoding varchar], [in content_language varchar], [in dtd_validator_config varchar], [in index_attrs integer]);
returns an entity object ('XPER entity') created from an XML document
xper_left_sibling (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
xper_length (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
xper_locate_words (in entityany, [in starting_word integer], [in ending_word integer]);
returns a smallest fragment of persistent XML entity object ('XPER entity') such that it contains some range of words in its text
xper_parent (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
xper_right_sibling (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
xper_root_entity (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
xper_tell (in xper_entityXML_entity);
low-level navigation functions for persistent XMLs, useful for import of huge amounts of XML data
void xpf_extension (in fname varchar, in procedure_name varchar);
declare an XPath extension function
void xpf_extension_remove (in fname varchar, in procedure_name varchar);
discards an XPath extension function
xquery_eval (in xquery_expression varchar, in xml_tree XML Entity, [in index integer], [in named_params vector]);
Applies an XQUERY expression to a context node and returns result(s).
xml_entity xslt (in sheet_uri varchar, in entity any, [in sheet_params vector]);
returns an XML document transformed by an XSLT stylesheet
xslt_format_number ( number any, format_string varchar);
returns formated string representation of a numeric value
xslt_sheet (in uri varchar, in entity any);
declares an XSL stylesheet for use
xslt_stale (in uri varchar);
force reload of XSL stylesheet
xte_head (in tagname varchar, [in attr1name varchar], [in attr1val varchar], ... , [in attrNname varchar], [in attrNval varchar]);
Returns the vector corresponding to a head of a XML element
xte_node (in head any, [in arg1 any], ... , [in argN any]);
Returns the vector corresponding to a XML element
xte_node_from_nodebld (in head any, inout element any);
Returns the vector corresponding to a XML element
xte_nodebld_acc (in acc any, in arg1 any, ... , in argN any);
Adds to the first arguments all remaining arguments
xte_nodebld_final (inout arg any, [in head any]);
Corrects input vector
xte_nodebld_init (inout arg any);
Creates the empty vector
xtree_doc (in document varchar, [in parser_mode integer], [in base_uri varchar], [in content_encoding varchar], [in content_language varchar], [in dtd_validator_config varchar]);
returns an entity object created from an XML document
year (in dt datetime);
decompose a datetime to its components