Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Available Tables

The catalog provides several tables that can be queried using standard SQL syntax. Use SHOW CATALOG TABLES to list all available tables in your catalog.

Discovering Tables

SHOW CATALOG TABLES;

Core Tables

CATALOG.ENTITIES

Information about all entities in the project.

ColumnDescription
IdUnique identifier
NameEntity name
ModuleNameModule containing the entity
QualifiedNameFull qualified name (Module.Entity)
EntityTypePersistent, Non-Persistent, View, External
DescriptionDocumentation text
AttributeCountNumber of attributes
AccessRuleCountNumber of access rules defined
SELECT Name, EntityType, AttributeCount
FROM CATALOG.ENTITIES
WHERE ModuleName = 'Sales'
ORDER BY Name;

CATALOG.ATTRIBUTES

Information about entity attributes.

ColumnDescription
IdUnique identifier
NameAttribute name
EntityIdParent entity ID
AttributeTypeString, Integer, Decimal, Boolean, DateTime, etc.
SELECT a.Name, a.AttributeType
FROM CATALOG.ATTRIBUTES a
JOIN CATALOG.ENTITIES e ON a.EntityId = e.Id
WHERE e.QualifiedName = 'Sales.Customer';

CATALOG.ASSOCIATIONS

Information about entity associations.

ColumnDescription
IdUnique identifier
NameAssociation name
ParentEntityParent (FROM) entity qualified name
ChildEntityChild (TO) entity qualified name
AssociationTypeReference or ReferenceSet
SELECT Name, ParentEntity, ChildEntity, AssociationType
FROM CATALOG.ASSOCIATIONS
WHERE ParentEntity LIKE '%Order%' OR ChildEntity LIKE '%Order%';

CATALOG.MICROFLOWS

Information about microflows and nanoflows.

ColumnDescription
IdUnique identifier
NameMicroflow name
ModuleNameModule containing the microflow
QualifiedNameFull qualified name
ReturnTypeReturn type of the microflow
DescriptionDocumentation text
ParametersParameter information
ObjectUsageEntities used in the microflow
SELECT Name, ReturnType, Description
FROM CATALOG.MICROFLOWS
WHERE ModuleName = 'Sales'
ORDER BY Name;

CATALOG.PAGES

Information about pages and their properties.

ColumnDescription
IdUnique identifier
NamePage name
ModuleNameModule containing the page
QualifiedNameFull qualified name
URLPage URL if configured
DataSourcePrimary data source
WidgetTypesTypes of widgets used
SELECT Name, URL, DataSource
FROM CATALOG.PAGES
WHERE ModuleName = 'Sales'
ORDER BY Name;

CATALOG.ACCESS_RULES

Information about entity access rules (available after full refresh).

ColumnDescription
IdUnique identifier
EntityIdEntity this rule applies to
UserRoleRole this rule grants access to
AllowReadWhether read access is granted
AllowWriteWhether write access is granted
SELECT e.QualifiedName, ar.UserRole, ar.AllowRead, ar.AllowWrite
FROM CATALOG.ACCESS_RULES ar
JOIN CATALOG.ENTITIES e ON ar.EntityId = e.Id
WHERE e.ModuleName = 'Sales';

Listing All Tables

To see the complete list of available tables in your catalog (which may vary by project and refresh level):

SHOW CATALOG TABLES;
mxcli -p app.mpr -c "SHOW CATALOG TABLES"