Home
Function Reference
1010data Insights Platform offers a rich set of functions that may be used in value expressions when creating computed columns and in selection expressions when performing row selections.
Object functions
The object functions can be used to check the existence, type, and accessibility of objects such as folders, tables, and queries on the 1010data Insights Platform.
obj_ldesc(path)
Returns the long description of the object at the given path. (Available as of version 10.23)

Function Reference
1010data Insights Platform offers a rich set of functions that may be used in value expressions when creating computed columns and in selection expressions when performing row selections.
- All 1010data Functions
  1010data provides a whole range of functions that can provide information and act on your data.
- Time/Date functions
  The time/date functions are vector functions that operate on columns containing time-related data and return specific information about the date/time for each row.
- Group functions (g_functions)
  Group functions, or g_functions, are used to perform operations, such as summarizations, on rows that have the same values in a set of given columns.
- Math functions
  Math functions are vector functions that perform mathematical operations on one or more columns and return a column of results based on the operation.
- Matrix functions
- Categorization functions
  Categorization functions are vector functions that organize data and determine logical groupings. These functions can be used for conditionalizing results and/or bucketing value ranges.
- String functions
  String functions are vector functions that manipulate vectors of strings to provide information about a string or substring, concatenate and split strings, or transform strings based on specified criteria.
- List functions
  List functions are scalar functions that return lists, subsets of lists, and combinations of lists, among other functionality. Lists, along with packages, are compound scalar data types that facilitate programmatic interaction with scalar data values and variables.
- Data-handling functions
  Data-handling functions are vector functions that return a hash value based on an input column or columns.
- Row functions
  Row functions are vector functions that return computational outputs for row inputs, as opposed to column outputs. Row inputs are defined as a space- or comma-separated list of column names.
- SQL compatibility functions
  SQL compatibility functions are functions that treat null values as SQL nulls.
- Financial functions
- System functions
  System functions are special functions in 1010data that return information about users, tables, and other system objects.
- Object functions
  The object functions can be used to check the existence, type, and accessibility of objects such as folders, tables, and queries on the 1010data Insights Platform.
  - obj_children(path)
    Returns the list of objects contained within the folder at the given path. (Available as of version 10.24)
  - obj_exists(path)
    Returns a boolean value that indicates if the object at the given path exists. (Available as of version 10.23)
  - obj_inherits(path)
    Returns a boolean value that indicates if user access to the object at the given path is inherited from the parent folder. (Available as of version 10.24)
  - obj_isfolder(path)
    Returns a boolean value that indicates if the object at the given path is a folder. (Available as of version 10.23)
  - obj_isphysical(path)
    Returns a boolean value that indicates if the object at the given path is a saved physical table. (Available as of version 10.23)
  - obj_isquery(path)
    Returns a boolean value that indicates if the object at the given path is a query. (Available as of version 10.23)
  - obj_istable(path)
    Returns a boolean value that indicates if the object at the given path is a table. (Available as of version 10.23)
  - obj_istemp(path)
    Returns a boolean value that indicates if the object at the given path is a temporary table in the user's session. (Available as of version 10.23)
  - obj_ldesc(path)
    Returns the long description of the object at the given path. (Available as of version 10.23)
  - obj_mode(path)
    Returns the display mode of the object at the given path. (Available as of version 10.23)
  - obj_name(path)
    Returns the name of the object at the given path. (Available as of version 10.24)
  - obj_own(path)
    Returns a boolean value that indicates if the object at the given path is owned by the current user. (Available as of version 10.23)
  - obj_owner(path)
    Returns the owner of the object at the given path. (Available as of version 10.23)
  - obj_parent(path)
    Returns the name of the folder in which the object at the given path is contained. (Available as of version 10.23)
  - obj_parents(path)
    Returns the hierarchical list of folders in which the object at the given path is contained. (Available as of version 10.24)
  - obj_readable(path)
    Returns a boolean value that indicates if the object at the given path can be accessed by the current user. (Available as of version 10.23)
  - obj_runnable(path)
    Returns a boolean value that indicates if the object at the given path can be opened by the current user. (Available as of version 10.23)
  - obj_sdesc(path)
    Returns the short description of the object at the given path. (Available as of version 10.23)
  - obj_title(path)
    Returns the title of the object at the given path. (Available as of version 10.23)
  - obj_type(path)
    Returns the type of the object at the given path. (Available as of version 10.23)
  - obj_uploaders(path)
    Returns the list of users that have specifically been given permission to save or upload objects to the folder at the given path. (Available as of version 10.24)
  - obj_users(path)
    Returns the list of users that have specifically been given permission to access the object at the given path. (Available as of version 10.24)
  - obj_writable(path)
    Returns a boolean value that indicates if the object at the given path can be modified and saved by the current user. (Available as of version 10.23)
- Miscellaneous functions
  This category of functions contains special functions that don't neatly fit into other categories of functions.

`obj_ldesc(path)`

Returns the long description of the object at the given path. (Available as of version 10.23)

Syntax

obj_ldesc(path)

Input

Argument Type Description

path

text

A path to an object (e.g., table, folder, query)

The path parameter can be a scalar value (e.g., pub.demo.retail.item) or the name of a column containing paths to objects.

If path is the empty string (e.g., ''), the function returns information corresponding to the root-level folder, which contains all of the top-level folders (e.g., pub, default, uploads).

Return Value

Returns a text value corresponding to the long description of the object at the specified path.

Returns an empty string if the path does not exist.

Example

The following example demonstrates the behavior of obj_ldesc(path) using the values in the example_path column specified via the <table> element.

<table cols="example_path">pub.demo.retail;
  pub.demo.retail.item;
  pub.demo.retail.selectionlib;
  pub.demo.retail.foo;
  default.doc.interactive.trsgsg_qa;
  default.doc.interactive.doc_lib;
  foo;
  ;
</table>
<col name="example_path" format="width:35"/>
<willbe name="obj_ldesc_result" value="obj_ldesc(example_path)"/>

Note: When the value of the path parameter is equal to the empty string, the function returns information corresponding to the root-level folder in the 1010data Insights Platform, which contains all of the top-level folders (e.g., pub, default, uploads).