Design

Back Next

doc-available

The doc-available function in XQuery checks whether a document identified by the given URI is available and can be retrieved without error.

fn:doc-available(uri)

The following table describes the argument for this command:

Argument	Required/Optional	Description
uri	Required	The URI identifying the XML document to check.

Returns

true

if the document is available and can be successfully retrieved.

Returns

false

if the document is not available, cannot be retrieved, or an error occurs during retrieval.

The following table lists some sample values and return values:

SAMPLE FUNCTION	OUTPUT
fn:doc-available("http://example.com/sample.xml")	true
fn:doc-available("nonexistent.xml")	false
fn:doc-available("")	false

Useful to safely check for document existence before attempting to retrieve it with

doc()

The function does not raise errors. It returns a boolean indicating availability.

Behavior may depend on the underlying XQuery processor and access rights.

Watch

Comments

0 COMMENTS

We’d like to hear from you! Log in to comment.