udbMeta function object

Previous Next

The object structure of the USoft DB Library has a global entry point for accessing meta data information about data sources:

$.udbMeta

This returns a DataSourceMetaContainer object that contains a set of data sources and provides the entrypoint to the meta data of a data source. When functions of this object are called, the object transfers the function call to each individual data source.

When calling $.udbMeta(), you can refer to data sources with arrays or simple strings, using the selection techniques below:

 

collapseSelecting by data source ID
collapseSelecting by data source type
collapse Selecting by name or path
collapseSelecting by frame ID

 

Functions

The DataSourceMetaContainer object exposes the following functions.

NOTE: All the functions listed in this table are equally exposed by the udb function object.

Object or Function

Description

udbMeta()

Function to get meta data of a data source with a given name.

.alias()

Function returns the alias of the first data source in the container.

.children()

Function that returns the related data source child ID's of the first data source in the container.

.cols()

Function returns the columns of the first data source in the container.

.currentDataSet()

Function that returns the currently selected data set's number of the first data source source in the container

.dataSetSize()

Function returns the size of a dataset of the first data source in the container.

.each()

Function to iterate executing a function for each matched data source.

.hasChild()

Function that returns the related data source children of the first data source in the container.

.hasCount()

Function that returns the hasCount property of the first data source in the container.

.hasLookup()

Function that returns true if the first data source in the container has lookup data sources, false if not.

.id()

Function returns the id of the first data source in the container.

.initialState()

Function that returns the initial state of the first data source in the container.

.isAutoQuery()

Function that returns true if the first data source in the container is automatically queried for more data sets

.isDefault()

Function returns whether the first data source in the container is default.

.isDeletable()

Function returns whether the first data source in the container is deletable.

.isDistinct()

Function that returns true if the first data source is Distinct, false if not

.isFirstRecordDefaultSelected()

Function that returns isFirstRecordDefaultSelected property of the first data source in the container.

.isInsertable()

Function returns whether the first data source in the container is insertable.

.isJoined()

Function that returns true if the first data source in the container is a joined table.

.isLookup()

Function that returns true if the first data source in the container is a lookup data source.

.isOnEmbeddedPage()

Function that returns true if the first data source in the container is on an embedded page.

.isUpdatable()

Function that returns whether anything in the data source is updatable.

.joins()

Function that returns list of joined child data sources of the first data source in the container.

.keyCols()

Function returns the key columns of the first data source in the container.

.lifeTime()

Function that returns the data set lifetime of the first data source in the container.

.lookupRefs()

Function that returns the lookup reference information for the first data source in the container

.lookups()

Function that returns the lookup information object of the first data source in the container.

.name()

Function returns the name of the first data source in the container.

.orphanDataSource()

Function that returns the associated (orphan) data source of the first data source in the container.

.pageAlias()

Function that returns the page alias of the first data source in the container.

.parents()

Function that returns the related data source parent ID's of the first data source in the container.

.path()

Function that returns the full data source path of the first data source in the container.

.realDataSource()

Function that returns the real data source ID (or the ID itself if not Virtual) of the first data source in the container.

.relations()

Function that returns the relation information of the first data source in the container.

.sortOrder()

Function that sets or removes the sort definition.

.table()

Function that returns the table name of the first data source in the container.

.type()

Function returns the type of the first data source in the container.