Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

FM.Relations

Queries relationships for current file as JSON.

Component Version macOS Windows Linux Server iOS SDK
FM 16.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "FM.Relations" { ; Flags } )   More

Parameters

Parameter Description Example Flags
Flags Various flags to control output.
Pass 1 to include fields.
Pass 2 to have a compact output.
Default is zero to skip fields.
1+2 Optional

Result

Returns JSON or error.

Description

Queries relationships for current file as JSON.
We query all table occurrences in the current context.
Then we check all relationships and report them. Each relationship has a source and destination table occurrence and at least one condition.

Examples

Query relations:

MBS("FM.Relations")

Example result:
[ { "TableName": "Assets", "TableID": 1065090, "BaseTableName": "Assets", "BaseFileName": "Assets", "ModCount": 1, "Relations": [ { "Source": "Assets", "Table": "Vendors", "Options": "Create", "Conditions": [ "Vendors::ForeignKey = Assets::PrimaryKey" ] }, { "Source": "Assets", "Table": "Assignments", "Options": "Create Sorted", "Conditions": [ "Assignments::AssetForeignKey = Assets::PrimaryKey" ] } ] }, { "TableName": "Assignments", "TableID": 1065093, "BaseTableName": "Assignments", "BaseFileName": "Assets", "ModCount": 2, "Relations": [ { "Source": "Assets", "Table": "Assets", "Options": "", "Conditions": [ "Assets::PrimaryKey = Assignments::AssetForeignKey" ] }, { "Source": "Assets", "Table": "Employees", "Options": "", "Conditions": [ "Employees::PrimaryKey = Assignments::EmployeeForeignKey" ] } ] }, { "TableName": "Employees", "TableID": 1065092, "BaseTableName": "Employees", "BaseFileName": "Assets", "ModCount": 2, "Relations": [ { "Source": "Assets", "Table": "Assignments", "Options": "", "Conditions": [ "Assignments::EmployeeForeignKey = Employees::PrimaryKey" ] } ] }, { "TableName": "Vendors", "TableID": 1065091, "BaseTableName": "Vendors", "BaseFileName": "Assets", "ModCount": 1, "Relations": [ { "Source": "Assets", "Table": "Assets", "Options": "", "Conditions": [ "Assets::PrimaryKey = Vendors::ForeignKey" ] } ] } ]

Release notes

Blog Entries

This function is free to use.

Created 7th September 2026, last changed 12nd October 2026


FM.RecordStatistics - FM.RunDatabaseDesignReport


MarkDown version: FMRelations.md