Variable Long Name¶
-
get_var_long_name
(tableName, varName)¶ Returns the long name of a given variable.
Parameters: - tableName: string
The name of the table associated with the dataset. A full list of table names can be found in the Data Catalog.
- variable: string or list of string
Variable short name. A full list of variable short names can be found in the Data Catalog.
Returns: String literal.
Example
Returns the long name of the short name variable, adt, in the Altimetry Reprocessed dataset.
#!pip install pycmap -q #uncomment to install pycmap, if necessary
import pycmap
api = pycmap.API(token='<YOUR_API_KEY>')
api.get_var_long_name('tblAltimetry_REP', 'adt')
SQL Statement
Here is how to achieve the same results using a direct SQL statement. Please refer to Query for more information.
EXEC uspVariableLongName 'tableName', 'varName'
Example
Returns the long name of the short name variable, adt, in the Altimetry Reprocessed dataset.
EXEC uspVariableLongName 'tblAltimetry_REP', 'adt'