R/env.R

In notebookutils: Dummy R APIs Used in 'Azure Synapse Analytics' for Local Developments

#' env.R: Utility for obtaining environment metadata (e.g, userName, clusterId etc)

#' @noRd
.dummyStr <- ""

#' Get cluster id.
#' 
#' @examples
#' mssparkutils.env.getClusterId()
#'
#' @return A empty string used to mimic cluster id of azure synapse runtime.
#' @export
mssparkutils.env.getClusterId <- function () {
   .dummyStr
}
#' Get cluster id.
#'
#' @examples
#' notebookutils.env.getClusterId()
#'
#' @return A empty string used to mimic cluster id of azure synapse runtime.
#' @export
notebookutils.env.getClusterId <- function () {
   .dummyStr
}
#' Get job Id.
#' 
#' @examples
#' mssparkutils.env.getJobId()
#'
#' @return A empty string used to mimic the id of spark job been submitted to azure synapse runtime.
#' @export
mssparkutils.env.getJobId <- function () {
   .dummyStr
}
#' Get job Id.
#'
#' @examples
#' notebookutils.env.getJobId()
#'
#' @return A empty string used to mimic the id of spark job been submitted to azure synapse runtime.
#' @export
notebookutils.env.getJobId <- function () {
   .dummyStr
}
#' Get pool name.
#' 
#' @examples
#' mssparkutils.env.getPoolName()
#'
#' @return A empty string used to mimic the name of user's azure synapse spark pool.
#' @export
mssparkutils.env.getPoolName <- function () {
   .dummyStr
}
#' Get pool name.
#'
#' @examples
#' notebookutils.env.getPoolName()
#'
#' @return A empty string used to mimic the name of user's azure synapse spark pool.
#' @export
notebookutils.env.getPoolName <- function () {
   .dummyStr
}
#' Get user name.
#' 
#' @examples
#' mssparkutils.env.getUserName()
#'
#' @return A empty string used to mimic the name of user.
#' @export
mssparkutils.env.getUserName <- function () {
   .dummyStr
}
#' Get user name.
#'
#' @examples
#' notebookutils.env.getUserName()
#'
#' @return A empty string used to mimic the name of user.
#' @export
notebookutils.env.getUserName <- function () {
   .dummyStr
}
#' Get user Id.
#' 
#' @examples
#' mssparkutils.env.getUserId()
#'
#' @return A empty string used to mimic the id of user.
#' @export
mssparkutils.env.getUserId <- function () {
   .dummyStr
}
#' Get user Id.
#'
#' @examples
#' notebookutils.env.getUserId()
#'
#' @return A empty string used to mimic the id of user.
#' @export
notebookutils.env.getUserId <- function () {
   .dummyStr
}
#' Get workspace name.
#' 
#' @examples
#' mssparkutils.env.getWorkspaceName()
#'
#' @return A empty string used to mimic the id of the user's azure synapse workspace.
#' @export
mssparkutils.env.getWorkspaceName <- function () {
   .dummyStr
}
#' Get workspace name.
#'
#' @examples
#' notebookutils.env.getWorkspaceName()
#'
#' @return A empty string used to mimic the id of the user's azure synapse workspace.
#' @export
notebookutils.env.getWorkspaceName <- function () {
   .dummyStr
}
#' Get help message.
#' 
#' @examples
#' mssparkutils.env.help()
#'
#' @return
#' No return value, print empty string to mimic the behavior of help method of mssparkutils env module
#' when used in azure synapse runtime.
#' @export
mssparkutils.env.help <- function () {
   paste0(.dummyStr)
}
#' Get help message.
#'
#' @examples
#' notebookutils.env.help()
#'
#' @return
#' No return value, print empty string to mimic the behavior of help method of mssparkutils env module
#' when used in azure synapse runtime.
#' @export
notebookutils.env.help <- function () {
   paste0(.dummyStr)
}
# Get help message for env group
mssparkutils.env.getHelpString <- function () {
    .dummyStr
}