R/Command.R

In RBaseX: 'BaseX' Client

#' Command
#'
#' @param ... 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.
#'
#' @return When used to execute commands in the Standard mode, this function returns a list with the following items:
#'     \itemize{
#'       \item {result}
#'       \item {info} {Aditional info}
#'       \item {success} {A boolean, indicating if the command was completed successfull}
#'     }
#'
#'     When used to execute a query, it return the result as a list.
#'
#' @description Executes a database command or a query.
#'
#' @details For a list of database commands see \url{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.
#'
#' @examples
#' \dontrun{
#' 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))
#' }
#'
#' @export
Command <- function(...) {
  arguments <- list(...)
  classType <- unlist(class(arguments[[1]]))[1]
  if ( classType == "BasexClient") {
    session <- arguments[[1]]
    comm <- arguments[[2]]
    return(session$Command(comm))
  } else {
    query_obj <- arguments[[1]][[1]]
    return(query_obj$ExecuteQuery())
  }
}