`obj_sdesc(path)`

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

Syntax

obj_sdesc(path)

Input

Argument Type Description

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).

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 short 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_sdesc(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_sdesc_result" value="obj_sdesc(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).