Command: Command

In RBaseX: 'BaseX' Client

Command

Description

Executes a database command or a query.

Usage

Command(...)

Arguments

...	The command or query to be executed. When used to execute a command, a SessionID and a string which contains the command, are to be passed. When used to execute a query, the QueryClass instance-ID is passed.

Details

For a list of database commands see https://docs.basex.org/wiki/Commands

'BaseX' can be used in a Standard mode or Query mode.

In the standard mode of the Clients, a database command can be sent to the server using the Command() function of the Session. The query mode of the Clients allows you to bind external variables to a query and evaluate the query in an iterative manner.

Value

When used to execute commands in the Standard mode, this function returns a list with the following items:

• result

• info Aditional info

• success A boolean, indicating if the command was completed successfull

When used to execute a query, it return the result as a list.

Examples

## Not run: 
Session <- NewBasexClient(user = <username>, password = "<password>")
print(Command(Session, "info")$info)

query_txt <- paste("for $i in 1 to 2", "return <xml>Text { $i }</xml>", sep = " ")
query_obj <- Query(Session, query_txt)
print(Command(query_obj))

## End(Not run)

RBaseX documentation built on Dec. 2, 2022, 5:10 p.m.