Book Home

Contents
Preface

Overview
Installation Guide
Quick Start & Tours
Sample ODBC & JDBC Applications
Conceptual Overview
Administration
Data Access Interfaces
Virtual Database Engine
SQL Reference
Virtuoso Cluster Programming
SQL Procedure Language Guide
Database Event Hooks
Data Replication, Synchronization and Transformation Services
Web Application Development
XML Support
RDF Data Access and Data Management
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

( in tablename varchar );
Checks a table for grants.
( in str varchar , outflags int );
Returns prefix by given URI.
( in str varchar , outflags int );
Returns URI by given namespace prefix.
( in num any );
Return the absolute value of a number
( in x double precision );
trigonometric functions
( val1 boolean , val2 boolean , ... , valN boolean );
Returns false if a value of some argument is false, otherwise returns true.
( in phrase_id integer , in description_phrases vector );
Adds phrases to given set.
( in phrase_set_ids vector of integers , in source_UTF8_text varchar not null , in lang_name varchar not null , in source_text_is_html integer , in report_flags integer );
Returns report of all occurrences of phrases from the specified sets in the text.
( seq1 sequence , seq2 sequence , ... , seqN sequence );
Creates an sequence of all items from given sequences.
( arg any , nth integer );
returns specific element of an array or string
( arg any );
Get ASCII value of a character
( in arg any , in nth integer , in new_elem any );
set array element
( in x double precision );
trigonometric functions
( var_name string , var_value any );
Creates a local variable and assign a value to it.
( in x double precision );
trigonometric functions
( in x double precision , in y double precision );
trigonometric functions
( in arg string );
Convert a string to single precision float
( in arg string );
Convert a string to an integer
( in dsn varchar , in table varchar );
Compose a fully qualified table name based on DSN and remote table name.
( arg1 any , arg2 any , ... , argN any );
Returns average value of all its arguments.
( 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.
( in file_prefix varchar , in pages integer , [in timeout integer] , [in dirs any] );
perform online backup of database
( in file varchar );
Write data into transaction log format for backup purposes. Deprecated.
( in row any );
Write data into transaction log format for backup purposes. Deprecated.
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( caddr_t * qst , state_slot_t ** args , int nth , char * func );
Get parameters for built in function
( in n1 integer , in n2 integer );
Returns bitwise AND of two 32-bit integers.
( in n1 integer );
Returns bitwise NOT of a 32-bit integer.
( in n1 integer , in n2 integer );
Returns bitwise OR of two 32-bit integers.
( in value integer , in distance integer );
Returns the result of bitwise shift operation over two 32-bit integers.
( 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
( in cursor CURSOR );
Return the bookmark for current row of a scrollable cursor
Converts its argument to boolean
( 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
( in scp_id int );
Makes a copy of an existing script
Returns a list of partner links used in the BPEL script
( in var_name varchar , in part varchar , in query varchar );
gets BPEL variable data within <bpelv:exec binding="SQL"> activity
( in base_uri varchar , in base_name varchar , in scp_id int );
Import a new BPEL process
delete a BPEL process instance
( in script varchar , in plink varchar , in opt varchar );
retrieving a partner link option
( in script varchar , in plink varchar , in opt varchar , in val any );
set value of a partner link option
( in completed_before datetime , in make_archive int (default 1) );
removes old BPEL process instances
( in script varchar , in delete_instances int );
Remove a BPEL process
( in script varchar );
mark a BPEL script as obsoleted
( in scp_id int , in url varchar , in content any );
Updates an existing script in BPEL repository
( in name varchar , in url varchar , in content any );
Upload a new BPEL script source
( 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
( in scp_id int , in url varchar , in content any , in pl varchar default 'wsdl' );
Uploads a WSDL description for a given BPEL script
( in x double precision );
Round a number to positive infinity.
( num number );
Returns the smallest integer that is not less than the argument.
( in path varchar , in section varchar );
return number of items in a section in configuration file
( in path varchar , in section varchar , in item_index integer );
get nth item name from ini file
( in path varchar , in section varchar , in item_name varchar );
returns the value of an item from the ini file
( in path varchar );
get number of sections in an INI file
( in path varchar , in index integer );
returns INI file section name
( in path varchar , in section varchar , in item_name varchar , in item_value varchar );
Writes the item=value to an INI file
( in name varchar , in charset_string any , in aliases any );
Define a character set.
( in src_string varchar/nvarchar , in src_charset varchar , in dst_charset varchar );
Translate a string to another character set
( in gen_res_set integer );
List known character set names and aliases.
( in minutes integer );
Configure database checkpointing
( in chr_codelong );
Convert a long character code to a character or wide character
( in attr varchar );
returns a varchar containing the requested information from the connection
( in COLLATION_NAME varchar , in FILE_PATH varchar , in ADD_TYPE integer );
define a new collation
( in tablename varchar , in mode integer );
Returns a fully qualified table name.
( in x any , ... );
create a composite object
( in c any , in nth integer );
get member of a composite object
( str1 varchar , str2 varchar , ... , strn varchar );
Concatenate strings
( strg1 string , strg2 string , ... , strgN string );
Returns the concatenation of its arguments.
( in arg_1 any , ... );
concatenate strings
( in name varchar );
Get connection variable
get connection identifier
check if current session connection variables have been altered
( in name varchar , in value any );
Associates a value to the name in the context of the present connection
Retrieve all connection variables
( in var_array any );
set all connection variables
( column varchar , expression varchar , [opt_or_valueinteger] );
A text contains predicate
( haystack string , needle string );
Returns true if the first argument string contains the second argument string, and otherwise returns false.
( in expr1 any , in expr2 any );
Returns the coefficient of correlation of a set of number pairs.
( in x double precision );
trigonometric functions
( in x double precision );
trigonometric functions
Returns the number of values in the sequence.
( in fname varchar );
Load test coverage data from file.
( in fname varchar , in outdir varchar );
Produce a text coverage report.
( in fname varchar , in add_comments integer );
Writes a test coverage to a file.
( in expr1 any , in expr2 any );
Returns the population covariance of a set of number pairs.
( in expr1 any , in expr2 any );
Returns the sample covariance of a set of number pairs.
( attrname string , attrvalue string );
Creates a special "attribute descriptor" object.
( comment-text string );
Creates a "comment" XML tree entity.
( head sequence , child1 any , child2 any , ... , childN any );
Creates an element with specified name, attributes and children
( piname string ); ( pivalue string );
Creates a "processing instruction" XML tree entity.
( 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
( in unit string , in number integer , in date datetime );
arithmetic add to a date
( in unit string , in date1 datetime , in date2 datetime );
get difference of 2 dates
( in date datetime );
convert a datetime from internal to external date-time representation
( in date datetime );
convert a datetime from internal to external date-time representation
( in dt datetime );
convert a timestamp to external format string in GMT
( in gid varchar , in auth_uid varchar , in auth_pwd varchar );
Functions for manipulating an existing DAV collection or resource
( 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
( 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
( 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
( in path varchar , in silent integer , in auth_uname varchar , in auth_pwd varchar );
functions for adding, updating, deleting of DAV collections or resources
( in gid varchar , in auth_uid varchar , in auth_pwd varchar );
Functions for manipulating an existing DAV collection or resource
( in uid varchar , in auth_uid varchar , in auth_pwd varchar );
Functions for manipulating an existing DAV collection or resource
( in path varchar , in recursive integer , in auth_uid varchar , in auth_pwd varchar );
Functions for searching a DAV collection or resource
( in host varchar , in url varchar , in root varchar , in dst varchar );
Export a retrieved Web site to another WebDAV enabled server
( in uid varchar );
Functions for manipulating an existing DAV collection or resource
( in id any , in type char(1) , in owned_tokens any := 1 );
Operations on locks of DAV collections and resources
( in id any , in type char(1) );
Operations on locks of DAV collections and resources
( in path varchar , in locktype varchar , in scope varchar , in token varchar , in owner_name varchar , in owned_tokens varchar , in depth varchar , in timeout_sec integer , in auth_uname varchar , in auth_pwd varchar );
Operations on locks of DAV collections and resources
( 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
( 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
( 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
( 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
( in path varchar , in what char(1) );
Functions for searching a DAV collection or resource
( in id integer , in what char(1) );
Functions for searching a DAV collection or resource
( in path varchar , in token varchar , in auth_uname varchar , in auth_pwd varchar );
Operations on locks of DAV collections and resources
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get day of month from a datetime
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get day of week from a datetime
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get day of year from a datetime
( in _name varchar , in _owner_uid integer , in _reader_gid integer , in _callback varchar , in _app_env any , in mode varchar , in auth_uname varchar , in auth_pwd varchar );
Returns APC_ID of a phrase class.
( in _name varchar , in auth_uname varchar , in auth_pwd varchar );
Deletes phrase set.
Alters IRI_ID columns to get IRI_ID_8.
( [in audit_mode integer] , [in str_value varchar] , [in graph_iri varchar] );
Fix RDF metadata corruption.
varchar ( in save_to_file integer := 0 ); ( in backup_name varchar := null );
Makes a backup copy of RDF metadata (i.e., descriptions of RDF Views and the like).
( in strg varchar , in base varchar , inout ttl_ses any );
Converts rdf xml to ttl.
Translates a geometry into a RDF box
Converts geo:lat and geo:long properties properties into geometries.
( in r varchar , in t varchar );
Returns 1 if language identifier r matches lang pattern t.
( in rdfxml_text varchar , in omt_top_rdf varchar , in graph_uri varchar );
Parses the content of RDF/XML text as a sequence of separate RDF triples.
( in strg varchar , in base varchar , in graph varchar , [in log_mode integer] , [in threads integer] );
Parses the content of large RDF/XML text as a sequence of separate RDF triples.
( in g_uri varchar , in s_uri varchar , in p_uri varchar , in o_uri varchar );
Performs simple insertion of a quad where object is a node.
( in g_uri varchar , in s_uri varchar , in p_uri varchar , in o_lit any );
Performs simple insertion of a quad where object is a literal value in 'SQL valmode'.
( in g_uri varchar , in s_uri varchar , in p_uri varchar , in o_lit any , in dt any , in lang varchar );
Performs simple insertion of a quad where object is a literal value in 'SQL valmode' and can be specified datatype and language.
( in s varchar , in p varchar , in call varchar := null );
Returns 1 if string s matches pattern p, 0 otherwise.
( in read_from_file integer , in backup_name varchar );
Restores RDF metadata (descriptions of RDF Views and the like) from previously saved backup.
( inout triples any , in print_top_level any , inout ses any );
Serializes vector of triples into a session, in RDF/XML syntax.
( inout triples any , inout ses any );
Serializes vector of triples into a session, in TURTLE syntax.
( in strg any , in base varchar , in graph varchar );
Returns a dict of triples in 'long valmode'.
( in graph varchar , in to_graph_name varchar );
Collects statistics for a given graph and saves it.
( in query varchar , in dflt_graph varchar , in maxrows integer );
Local execution of SPARQL via SPARQL protocol, produces a result set of SQL values.
( in query varchar , in dflt_graph varchar , in maxrows integer );
Local execution of SPARQL via SPARQL protocol, produces a vector of vectors of SQL values.
( in service varchar , in query varchar , in dflt_graph varchar , in named_graphs any , in req_hdr any , in maxrows integer , in bnode_dict any );
Remote execution of SPARQL via SPARQL protocol, produces a result set of SQL values.
( in service varchar , in query varchar , in dflt_graph varchar , in named_graphs any , in req_hdr any , in maxrows integer , in bnode_dict any );
Remote execution of SPARQL via SPARQL protocol, produces a vector of vectors of SQL value.
( in service varchar , in query varchar , in dflt_graph varchar , in named_graphs any , in req_hdr any , in maxrows integer , in bnode_dict any , out metadata any , out resultset any );
Remote execution of SPARQL via SPARQL protocol. Fills in output parameters with metadata (like exec metadata) and a vector of vector s of 'long valmode' values.
( in strg any , in base varchar , in graph varchar , in flags integer );
parses TTL (TURTLE or N3 resource) and places its triples into DB.DBA.RDF_QUAD.
( in strg any , in base varchar , [in graph varchar] , [in flags integer] , [in log_mode integer] , [in threads integer] );
parses TTL (TURTLE or N3 resource) and places its triples into DB.DBA.RDF_QUAD on multiple threads.
( in path varchar , in base varchar , [in graph varchar] , [in flags integer] , [in log_mode integer] , [in threads integer] );
parses TTL (TURTLE or N3 resource) and places its triples into DB.DBA.RDF_QUAD on multiple threads.
( in table_name varchar (default %) , in index_name varchar (default %) );
Compact the database
( in arg1 any , ... );
print to the Virtuoso system console
( in format varchar , in arg1 any , ... , in argn any );
print formatted output onto the system console
get current catalog
( in str varchar );
base64-encode/decode a string
( in x double precision );
trigonometric functions
( in n_seconds integer );
sleep for n seconds
convert any heterogeneous array or tree of arrays into a binary string and back
( in dict dictionary );
Creates a copy of the given dictionary.
( in dict dictionary , in key any , [in default_value any] );
Returns the dependent part that corresponds to the given key in the given dictionary.
( inout dict dictionary , in destructive any );
Returns an array of all keys stored in the given dictionary.
( [in size integer] );
Creates a new dictionary to store key-value pairs.
( inout dict dictionary , in key any , in value any );
Adds a key-value pair to a dictionary
( inout dict dictionary , inout key any );
Removes the given key and associated dependent value from the given dictionary.
( inout dict dictionary , in destructive any );
Returns a get_keyword style vector of all items stored in the given dictionary.
( in username_patternstring );
Disconnect client connections of a given user
( input sequence );
Removes double entities from the input sequence
( document_uri varchar );
Returns data from XML doc other than the main source 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.
( 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.
( 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.
( in dt datetime , in tz integer );
modifies the timezone component of a datetime
( internal_type integer );
returns the internal type name of the argument
( elt1 , .... , elt-n );
return an array of either long, float or double
( in cond any , in arg1 any , in arg2 any );
conditionally return one of specified parameters
( encoding_handler_t * encoding , language_handler_t * language );
get localization function handler
( encodedlang_handler_t * new_handler );
load encoding handler into system
Returns true if given argument is an empty sequence, false if it is any single value or nonempty sequence.
( in str varchar );
base64-encode/decode a string
End the current result set.
( strg string , suffix string );
Returns true if the first argument string ends with the second argument string, and otherwise returns false.
( arg1 any , arg2 any );
comparison functions
( varname string , test_set sequence , test_expn boolean );
Returns true if all items of given sequence matches given criterion.
( set1 sequence , set2 sequence );
Returns a difference of two sets
( 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
( in cursor_handle long );
Closes cursor created by exec()
( in str varchar , out state varchar , out message varchar , out metadata vector );
Compiles a SQL statement and returns the metadata
( in cursor_handle long , out sql_state varchar , out sql_error varchar , out row_array vector );
Get next result from a result set
( in res_values_array any );
Returns a result set row to the calling procedure context
( in res_names_array any );
Supplies column details for procedure result set output.
( in str varchar , out state varchar , out message varchar );
Compiles a SQL statement and returns the estimate time cost
( in x double precision );
calculate exponent
( in textvarchar , [in cursor_type integer] );
describe SQL statement compilation
Returns false.
( in path varchar , in silent integer );
Delete a file from the file system
( in path varchar , [in what integer] , [out error any] );
Returns list with content of file system directory
( in path varchar , [out error any] );
Creates a directory in the file system
( in path varchar , [inout istest integer] );
Make a directory chain
( in path varchar , in what integer );
get various OS statistics about a file
( in path varchar );
returns the contents of a file as a varchar
( in file varchar , in from integer , in to integer );
get contents of a file as a string output stream
( in path varchar );
Delete a file from the file system
( selection sequence );
Composes trees of shallow copies of given XML entities.
alter default foreign key checking behavior
( in x double precision );
Round a number to negative infinity.
( num number );
Returns the largest integer that is not greater than the argument.
( [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.
( varname string , source_set sequence , mapping_expn any );
Repeats some calculation for every item of a given sequence
( num number , format_pattern string , [decimal_format string] );
( 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
( in server varchar , in user varchar , in pass varchar , in remote_dir_name varchar , [in is_pasv integer] );
FTP dir command; Virtuoso FTP client
( 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.
( elt1 , .... , elt-n );
return an array of either long, float or double
( place node_set );
Returns a string that uniquely identifies the node.
( in tb any , in geo any , in id int );
Deletes a geometry from an R tree index.
( in tb any , in geo any , in id int );
Inserts a geometry from an R tree index.
( in typeinteger , in cert_or_key_namevarchar , in in_formatint , in passwdvarchar , in ext_oidvarchar );
Returns information about the current client X509 certificate
( keyword any , searched_array vector , [default any] , [no_copy integer] );
Find a value in keyword vector
( 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
( in arg1any , in arg2any );
comparison functions
( inarg1 any , inarg2 any );
comparison functions
( in str varchar );
Compress data using gzip algorithm
( in path varchar );
returns the contents of a gzipped file
( in str varchar , out str_out string_output );
Uncompress a string using gzip algorithm
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get hour from a datetime
( in doi_val string );
Returns URL that represents the given DOI
( in val_expr any , [in stream any] );
write to HTTP client or a string output stream
( 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
( in list_name varchar , in order integer , in client_ip varchar , in flag integer );
Removes conditions against web server ACL's
( in list_name varchar , in order integer , in client_ip varchar , in flag integer , [in destination_ip_or_host varchar] , [in object_id integer] , [in read_write_flag integer] , in rate integer );
Set conditions against web server ACL's
Reads the HTTP body from the client HTTP connection and returns it as a string.
( 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] , [in timeout varchar] , [in proxy varchar] );
returns a varchar containing the body of the request uri
( 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] , inout headers any , [in timeout varchar] , [in proxy varchar] );
returns a varchar containing the body of the request uri
( [in what integer] );
Returns the IP address of the calling client.
( in file_path varchar );
set WebDAV HTTP request logging
( in mode integer );
Enable / Disable "Content-Encoding: gzip" for HTTP server
( in path varchar );
Send a file to the HTTP client
( [in try_what integer] );
Flush internal HTTP stream and disconnect client; Flush HTTP stream and try sending data in chunked mode.
( 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
( in head varchar );
Specifies non-default HTTP response headers
returns header of current HTTP request
( in client_IP_address varchar , in URL varchar , [in process_request_id integer] );
Kill VSP process whose details match parameter inputs
( in interface_address varchar , in action integer , [in options vector] );
Starts, stops and retrieves the state of a user-defined HTTP listener
( in element_name varchar );
get values from HTTP virtual host path mapping 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
( [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
( in host varchar , in header any , in content varchar );
proxy request to another host and return content to calling client
( in variable_name varchar );
Access to the HTTP request line
( [in array any] , [in field_name varchar] , [in attr-name varchar] , [in default_value varchar] );
returns array of HTTP request header lines
( in status_line varchar );
set the status sent to the client in an HTTP response
( [in stream any] );
Clears output written to a string output or to an HTTP
Returns the absolute path of the server root directory.
( in val_expr any , [in tag varchar] , [in stream any] );
write to HTTP client or string output stream with URL escapes
( in val_exprany , [in tag varchar] , [in stream any] );
write to HTTP client or string output stream with HTML escapes
( in xslt_uri varchar , [in params any] );
applies an XSLT stylesheet to the output of a VSP page
( ids any );
Returns an entities whose ID attributes are in the given list
returns the last assigned identity column value
( test boolean , then_branch any , else_branch any );
If the boolean value is true then calculates one expression, otherwise calculates another expression.
( 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.
( in files any , in classes any , [in security_mode integer] );
Creates SQL wrapper types of selected Java classes
( str string );
returns its argument with the first letter capitalized
( internal_type integer );
returns the integer standard SQL type of its argument
( arg anything );
returns internal integer datatype of its argument
( internal_type integer );
returns the internal type name of the argument
( set1 sequence , set2 sequence );
Returns an intersect of two sets
( in qname varchar , [out local varchar] );
Splits into the namespace prefix and the local part according to the TTL rules.
( ent1 entity , ent2 entity );
Returns true if the given entity is after the second given entity in document order, otherwise returns false.
( 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
( arg anything );
returns true if its argument is of type varbinary
( arg anything );
returns true if its argument is of type long varchar
( arg anything );
returns true is argument is a double
returns true if its argument is an XML entity
( arg anything );
returns true if its argument is a float
( in x any );
Returns 1 if the argument is a geometry.
( arg anything );
returns true if its argument is of type integer
( arg anything );
returns true if its argument is NULL
( arg anything );
returns true if argument is of numeric type
( in iri any );
Returns true if non-blank IRI
( arg anything );
returns true if its argument is of type varchar
( arg any );
returns true if argument is numeric zero
( in class_name varchar , in instance_obj varchar , in method_name varchar , in method_ret_sig varchar , [ arg1, ... ] );
( 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.
( in java_class_name varchar , in java_class_bytecode varchar );
Declares a Java class to a Java VM
( in class_name varchar , [in arg1 any] , [ ... ] );
Creates and instance of a Java class.
( 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
( in classpath varchar , [in vm_options any] );
Detaches the current Virtuoso working thread from the Java VM.
( in files any , in classes any );
Creates XML description of Java class
( keyname string , keyvalues any );
This XSLT 1.0 function is not implemented in the current version of Virtuoso.
( in table_name varchar , in index_name varchar , in k1 any , ... );
Get an estimate of row count for a given set of leading index key parts
( lang_name string );
Returns true if the language of context node matches given language name.
Returns the context size from expression evaluation context.
( str string );
Converts string argument to lower case
( 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.
( 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.
( in server_url varchar , in try_tls integer , in data varchar , in username varchar , in password varchar );
Modifies an existing LDAP directory.
( 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.
( str string , count integer );
returns substring taken from left of string argument
( in arg any );
Get length of argument
( 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
( in host varchar , in url varchar , in root varchar , in dst varchar );
Export retrieved web site to the local file system
( const char *language_name );
Returns language handler
( lang_handler_t * new_handler );
Loads given handler in global table of the server
( seq1 sequence , seq2 sequence , ... , seqN sequence );
Selects the first item of every argument sequence and returns the sequence of the selected items
( [node_obj any] );
Returns the local part of the expanded name of the argument.
( 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
( in x double precision );
calculate natural logarithm of an expression
( in x double precision );
Calculate 10-based logarithms
( [in bits integer in quiet integer] );
controls transaction logging and in-statement autocommit
( in text varchar , [in arg_1 any] , [...] );
inserts statements into the roll forward log
( str string );
returns a lower case version of its argument
( in arg1any , in arg2any );
comparison functions
( in arg1any , in arg2any );
comparison functions
( str string , [trimchars string] );
removes specific characters from a string
( elt1 , .... , elt-n );
return an array of either long, float or double
( in length integer , in content varchar );
returns a new array
( in count integer );
make a string
( arg1 any , arg2 any , ... , argN any );
Returns maximum value among all its arguments.
( in str varchar );
returns the md5 checksum of its argument
( in ctx varchar );
returns the md5 checksum given an initialized md5 context
returns the string serialization of a new md5 context
( in ctx varchar , in data varchar );
returns the updated md5 context serialized as varchar
( in mime_parts any );
used to compose multipart/mixed MIME message body
( in content_type varchar , in content_disposition varchar , in transfer_encoding varchar , in data varchar );
used to compose a MIME message body part.
( in message_text string , [in flag integer ] );
parses MIME messages into an array structure
( arg1 any , arg2 any , ... , argN any );
Returns minimum value among all its arguments.
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get minute from a datetime
( dividend integer , divisor integer );
returns the modulus of its arguments
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get number of month from a datetime
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get name of month from a datetime
Get number of milliseconds from system epoch
( in reconnect integer );
connects Virtuoso server to MS DTC.
returns timeout of distributed transaction in milliseconds.
( in timeout integer );
sets timeout of distributed transaction.
( in subject varchar );
checks status of current transaction or server.
( [node_obj any] );
Returns the expanded name of the argument.
( in string varchar , in idx integer , in dstring varchar );
Returns portion of dotted name such as a fully qualified table name.
( node_obj any );
Returns the namespace URI of the extended name of the given node
( in arg1any , in arg2any );
comparison functions
( 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
( in server varchar , in user varchar , in password varchar , in body varchar );
Post message to NNTP server with authorization
( in server varchar , in command varchar , in group varchar , [in first_message integer] , [in last_message integer] );
Returns information about an NNTP server.
( in server varchar , in body varchar );
Post message to NNTP server
Returns the argument string with whitespace normalized.
( obj boolean );
Returns true if its argument is false, and false otherwise.
returns the current transaction timestamp
( [obj any] );
Converts its argument to a number.
( val1 boolean , val2 boolean , ... , valN boolean );
Returns true if a value of some argument is true, otherwise returns false.
( in path varchar , in new_mod integer );
changes the file access mode of a file
( in path varchar , in username varchar , in groupname varchar );
changes the owning group/user of a file
( in pem_string varchar );
converts a PEM file to an array of PEM strings
trigonometric functions
( [in name varchar] , [in add_line_info integer] );
Makes an array of line/count information based on current coverage.
( in info any );
Used to load a coverage of a single procedure record as an array.
( 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
( 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.
( in x double precision , in y double precision );
return value of expression raised to specified power.
( 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.
( 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.
( xsql_page_uri string );
Executes XSQL page and returns the result.
( in flag integer );
Control virtuoso profiling
( in desc varchar , in time_spent integer , in flag integer );
Adds a profiling sample to a profile being accumulated.
( expn1 any , expn2 any , ... , expnN any );
Calculates all given expressions and returns the result produced by the last one.
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get number of quarter of year from a datetime
( in dsn varchar , in identifier varchar );
Returns an quoted identifier.
( in x double precision );
trigonometric functions
( in seed integer );
initializes the random number generator
( in cursor_handle long );
Closes cursor created by rexecute()
( [in name varchar] , [in graph_iri varchar] , [in remove integer] );
Adds the applicable facts of the graph into a rule set.
( 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.
( in source_string any , in pattern any , [in match_parameter integer] );
Allows a like comparison using regular-expression.
( in pattern any , inout str any , [in change_the_str integer] );
returns a substring matching the regular expression to the supplied string
( in pattern string , in target_string string , in offset integer );
returns substrings that match the regular expression in supplied string after an offset
( 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.
( in pattern (varchar|nvarchar) , in str (varchar|nvarchar) , in offset integer );
returns a single captured substring from matched substring
( 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.
( in name varchar );
Remove a variable from registry
( in name varchar , in value varchar , [in force integer] );
Associates a value to the name in the Database registry
( in expr1 any , in expr2 any );
Evaluates the average of the independent variable (expr2) of the regression line.
( in expr1 any , in expr2 any );
Evaluates the average of the independent variable (expr1) of the regression line.
( in expr1 any , in expr2 any );
Returns the number of non-null numbers used to fit the regression line.
( in expr1 any , in expr2 any );
Returns the y-intercept of the regression line.
( in expr1 any , in expr2 any );
Returns the coefficient of determination (R-squared) of the regression line.
( in expr1 any , in expr2 any );
Returns the slope of the line.
( in expr1 any , in expr2 any );
Auxiliary function used to compute various diagnostic statistics.
( in expr1 any , in expr2 any );
Auxiliary function used to compute various diagnostic statistics.
( in expr1 any , in expr2 any );
Auxiliary function used to compute various diagnostic statistics.
( in str string , in count integer );
returns a new string consisting of its string argument repeated a given number of times
( 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
( in col varchar , in name_suffix varchar , in order integer , in class varchar );
Creates conflict resolver for bi-directional replication in DAV
( 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
( in item varchar , in type integer );
Create bi-directional snapshot publication
( in server varchar , in item varchar , in type integer );
Create bi-directional snapshot subscription to an existing publication.
( in publisher varchar );
terminates communication with a replication publisher
( in item varchar , in type integer );
Drop bi-directional snapshot publication
( in server varchar , in item varchar , in type integer );
Drops a subscription to a bi-directional snapshot publication
( in publication varchar , in grantee varchar );
grant privileges for subscription to a publication
( in server_name varchar , in publication varchar );
create initial subscription state
( in server varchar , in item varchar , in type integer , [in how_many integer] );
Initializes a bi-directional snapshot publication
( in publication varchar , in file varchar );
create new publication log
( in publication varchar , in item varchar , in type integer , in mode integer , in procedure_replication_options integer );
add item to a publication
( in publication varchar , in image_file_path varchar , in bytes_per_file integer );
create initial image of publication on publisher
( in publication varchar , in item varchar , in type integer , in flag integer );
remove item from publication.
( in publication varchar , in log_path varchar , [in is_updateable integer] , [in sync_user varchar] );
create publication on publisher
( in server varchar , in account varchar );
purges transactional replication logs for specified account
( in publication varchar , in grantee varchar );
revoke privileges for subscription
adds scheduled job to synchronize subscriptions
( 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
( in old_namevarchar , in new_namevarchar );
rename the publishing server instance
( in dsn varchar , in uid varchar , in pwd varchar );
Define bi-directional snapshot replication server name
retrieve status of all subscriptions and publications
( in publisher varchar , in publication varchar , out level integer , out stat integer );
returns status of a published or subscribed publication
( 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
( in publisher varchar , in publication varchar , in uid varchar , in password varchar );
starts the syncing process against an existing subscription
synchronize all subscriptions
( in publication varchar , in sqltext varchar , in a-1 any , ... );
adds a SQL statement to the log of the replication
returns calling servers name
( in publication varchar );
drop publication on publisher
( in server_name varchar , in publication varchar , in item varchar );
drop subscription
( in item varchar , in type integer );
Updates a bi-directional snapshot publication
( 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.
( txt string , search_strg string , replace_strg string );
Searches for an substring and replace its occurrences with other substring.
( in log_file varchar );
starts the roll forward of the given log
( in col_1 any , .. , in col_n any );
Sends one row of results to the calling client.
( in var_1 , ... , in var_n );
( 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
( in str string , in count integer );
get n rightmost characters of a string
( 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()
( in n integer );
returns a random number between 0 and n - 1 inclusive
( in cursor_handle long , out row_array vector , out sql_state varchar , out sql_error varchar );
Get next result from a remote result set
( num number );
Returns the integer that is the nearest to the argument.
returns number of rows affected by the previous DML statement in a procedure body
( 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.
( str string , [trimchars string] );
trims given characters from right of given string
( 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
( in dt datetime );
decompose a datetime to its components
( in dt datetime );
get second from a datetime
Returns a vector of states of all sequence objects
( in name varchar , in increment_by integer );
Returns the current state of the specified sequence and increments it by one.
( in name varchar );
Removes a sequence object
( 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.
( 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
Returns server working directory.
( in host_and_port varchar );
Opens a TCP session and returns its handle.
( in ses ses_handle );
Disconnections a TCP session.
( [in ses any] , [in throw_exception_on_eof integer] , [in binary_modeinteger ] );
Read a line of character data from a TCP session.
( in buffer varchar , [in ses session_handle] );
Write character data to an open TCP session.
( in table_name varchar , in column_name varchar , in new_value integer );
sets the sequence starting value for an identity column
( in increment integer , [in what integer] );
sets the affected rows counter in the current context or in the context of the caller
( in user_name varchar , in mode integer , in password varchar );
sets the current user for execution
( ent entity );
Returns a shallow copy of the given XML entity
( num numeric );
returns -1, 0, or 1 depending on the sign of its numerical
( in sqlstate varchar , in message varchar );
Signal an exception in the calling procedure
( in x double precision );
trigonometric functions
( in _SINVM_NAME_IN varchar , in _SINV_INVERSE any , in _SINVM_FLAGS integer );
Creates inverse mapping for the mentioned functions.
( in map_name varchar , in part_defs any , in do_drops integer := 1 );
Creates a key mapping function & table.
( in _SINVM_NAME_IN varchar );
Reverses the effect of sinv_create_inverse procedure.
( 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
( in msg_text varchar , in certs any , [out signer_certs any] , [in flags integer] );
Verifies signature of signed MIME message
( in server string , in sender string , in recipient string , in body string );
send message to SMTP server
( in elem1 varchar , in value1 any , in ... , in elem1 varchar , in value1 any );
( 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.
( 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
( 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.
( in namevarchar , in schema_stringvarchar );
define re-define or erase the complex datatype definition for SOAP calls
( 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.
( 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.
( in module_name varchar , [in URL varchar] );
Generate SDL document for a PL module and return it as a varchar.
( 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.
( in module_namevarchar , [in URLvarchar] );
Generate WSDL document for a PL module and return it as a varchar.
( in target_url varchar );
( varname string , test_set sequence , test_expn boolean );
Returns true if at least one item of given sequence matches given criterion.
( in count integer );
returns a new string of count spaces
( in coded_str varchar , [in case_mode integer] , [in str varchar] );
converts escaped var=val pairs to a vector of strings
( format string , arg_1 any , ... , arg_x any );
returns a formatted string
( strg string , format string , err integer );
returns vector on a specified pattern.
( format string , arg_1 any , ... , arg_x any );
returns a formatted string that is marked as an IRI string.
( format string , arg_1 any , ... , arg_x any );
returns a formatted IRI string or null if any of the arguments except the first is null.
( format string , arg_1 any , ... , arg_x any );
returns a formatted string or null if any of the arguments except the first is null.
( constant column_name varchar );
Returns the value of a column from SQL result-set.
( 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
( in driver varchar , in type varchar , in attrib varchar );
Configures a remote DSN as in the DSN attribute string
get list of available DSNs
( in conn_str varchar );
Tries connecting using supplied connection string
get column information from table on a remote DSN
( in dsn varchar , in type varchar );
Gets the DSN's attributes list
( in dsn varchar , in type integer );
return type information from a remote DSN
( in dsn varchar , in qualifier varchar , in owner varchar , in table_name varchar );
get primary key information about a table on a remote DSN
( in dsn varchar , in qualifier varchar , in owner varchar , in name varchar );
get procedures information for a remote DSN
( in dsn varchar , in dsn_type varchar );
removes a DSN from the ODBC registry
( 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
( 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
( in dsn varchar , in qualifier varchar , in owner varchar , in table_name varchar , in tabletype varchar );
get list of tables from remote DSN
( in dsn_name varchar , [in rollback integer] );
get list of available DSNs
( in dsn varchar , in string varchar , in value varchar );
Creates a new file DSN
( in dsn varchar , in type varchar , in name varchar , in value varchar );
Sets a DSN's attribute value
( in x double precision );
calculate square root
( in g any );
Returns the well known text (WKT) representation of the geometry.
( in g1 any , in g2 any , in prec double precision );
Returns true if all points of a given geometry g2 are in another geometry g1.
( in g1 any , in g2 any );
Returns the shortest distance between two points.
( in string varchar );
Parses the string and returns the corresponding geometry.
( in g1 any , in g2 any , in prec double precision );
Returns intersects between two geometries.
( in x double precision , in y double precision );
Returns a point geometry.
( in g any , in srid int );
The geometry given as argument is modified to have the specified srid and the modified geometry is returned.
( in g any );
Returns the srid of a geometry.
( in g1 any