APIs
ref

ref Function

Summary:

ref functions are used to retrieve information related to a cell with a given reference name. The function returns detailed information including the ID, name, type, associated code, connection type and connection slug of the cell.

Parameters:

  • reference (str): name of the cell to retrieve.
  • base_url (str, optional): base URL of the API.
  • team_slug (str, optional): team slug.
  • authorisation (str, optional): authorisation information.
  • notebook_id (str, optional): notebook ID.

Response:

  • RefResponse: contains detailed information about the cell retrieved.

Usage example:

from morphdb_utils.api import ref
 
data = {
    "sheet_cell": load_data(ref("sheet_cell")),
}
 
@transform
def main(data: Dict[str, pd.DataFrame]):
    df = data["sheet_cell"]

ref

@apiexecute_sql