Custom rules
pbiplint's own rules are the same for everyone. Most teams also have rules of their own: measures in a folder, visible names in plain words, Power Query that reads only the approved schemas. Custom rules let your team check those too, from the rule files it already keeps in Tabular Editor's Best Practice Analyzer format (BPARules.json), with nothing else installed. pbiplint runs them beside its own rules, on the semantic model and the Power Query code it holds, wherever pbiplint runs: on this site, on the command line, in pbiplint mcp, and in your GitHub Actions and Azure Pipelines.
On pbiplint.com, custom rules run now. In a copy your firm hosts, on the command line, and in the pipelines, they run from pbiplint 0.4.0; pbiplint --version says which you have, and a self-hosted copy names its version in each page's footer. A team that has never written a rule can have an AI assistant write one, with the skill and the reference pbiplint ships (below).
A rule file holds rules for the semantic model and its Power Query. Rules for the report, in fab-inspector's format, come in a later release.
Set up customRules
Put the rule file in the project's repository and name it in customRules in pbiplint.config.json. The config is the one place pbiplint reads it from, so the site, the command line, and the pipelines all run the same rules; there is no command-line option for it.
pbiplint.config.json{
"$schema": "https://pbiplint.com/schema/pbiplint.config.schema.json",
"customRules": ["rules/team.json"],
"rules": {
"TEAM_MEASURE_DESCRIPTIONS": "error"
}
}
- Paths are relative to the folder
pbiplint.config.jsonis in, with/or\between folders.customRulestakes a list, and the files run in the order it lists them. - Local files only. A URL or an absolute path, such as
C:\rules\team.json, is refused as a config error that names the entry, since the site and the pipelines could not open it. - A file that cannot be used stops the lint. A file that is not there, cannot be read, is over 1,048,576 bytes, or is not a rule file, stops that project's lint with a message naming the config and the file; on the command line it exits
2. Linting on without the team's rules would let a gate pass that should not. - The usual settings work on custom ids. Under
rules,"TEAM_MEASURE_DESCRIPTIONS": "off"turns one off and"error"changes its severity, andfailOncounts custom findings like any other.annotation pbiplint.ignore = TEAM_MEASURE_DESCRIPTIONSunder an object in its TMDL file ignores the rule there, and so does Tabular Editor's own annotation. - Several projects: in a run over a folder of projects, each project runs the rules its own nearest config names. A config several projects share reads its rule files once.
A folder laid out like this works everywhere pbiplint runs, the site included:
Sales/
pbiplint.config.json
rules/
team.json
Sales.pbip
Sales.SemanticModel/
Sales.Report/
The rule file
A rule file is a JSON array of rules, or an object whose rules key holds that array; Tabular Editor reads both, and so does pbiplint. Comments (// and /* */), a byte order mark, and keys in any case are read too, as Tabular Editor reads them. Here is a file with one rule:
[
{
"ID": "TEAM_MEASURE_DESCRIPTIONS",
"Name": "Visible measures have a description",
"Category": "Documentation",
"Description": "Flags a visible measure with no description.\n\nThe description is what a report author sees when they hover over the measure in the field list, and it is the only place that says what the number means.\n\nWrite one or two sentences on what the measure calculates and when to use it. If the measure is a helper no report should use, hide it instead.",
"Severity": 2,
"Scope": "Measure",
"Expression": "IsVisible and string.IsNullOrWhiteSpace(Description)"
}
]
IDnames the rule in every finding, in your config, and in--rule. Ids match without regard to case. Give your team's rules a prefix, such asTEAM_, so they stay apart from pbiplint's;pbiplint ruleslists those. A rule with one of pbiplint's ids is handled as the next section says.Nameis the short title every finding shows, andDescriptionstands in where one of pbiplint's rules links to its page, so whoever meets a finding reads it. Write it in three paragraphs, as a rule page has them: what the rule checks, why the team wants it, and how to fix a finding.Categorygroups the rule in the results, written as the file writes it. Within a severity, custom categories come after pbiplint's own eight, in alphabetical order, as the site's category filter lists them; a rule with none is inCustom.Scopenames the object types the rule runs on, separated by commas, such as"DataColumn, CalculatedColumn, Hierarchy". The reference lists every scope.Expressionis a condition in Tabular Editor's expression language. Each object it is true for is a finding. A bare name such asIsVisibleis a property of the object the rule runs on, which is alsoit; inside a condition such asColumns.Any(...),itis the element being tested,outerItthe one a level out, andcurrentalways the object the rule runs on. The expression is a JSON string, so each"inside it is written\".Severitysets how serious a finding is. ASeveritybelow 2 is info, from 2 up to 3 a warning, and 3 or more an error; a rule with none reads as 1, info. Tabular Editor's own command line labelsSeverity1 as a warning; pbiplint reads 1 as info, as its built-in rules read Microsoft's numbers, so a team moving from it sees those rules as info. Set a rule's severity in your config to change it.IsDisabledis read, but the rule still runs, as Tabular Editor's command line runs it; turn a rule off in your config instead.FixExpressionandCompatibilityLevelare ignored.
pbiplint reads at most 2,000 rules from one file, and an Expression of at most 20,000 characters; a rule past either limit is reported as not read. The reference lists every property, function, and limit.
A rule with one of pbiplint's ids
Most team files start from Microsoft's ruleset, so they carry rules with the same ids as pbiplint's own, which pbiplint already runs. pbiplint tells the copies apart by comparing each one with every version of that rule published when this release was built: Microsoft's BPARules.json (opens in a new tab) in every language, and Tabular Editor's own rule files. A copy is unchanged when its scope is the same and its expression is the same, whitespace aside, as any of those versions.
- An unchanged copy is not run again. pbiplint runs its own rule, with its rule page.
- An unchanged copy with a different severity sets the severity of pbiplint's rule for that project, since the change is your team's policy. A severity your config sets for the id wins over both.
- An edited copy runs in place of pbiplint's rule for that project, as your team's rule, with its own name and description; pbiplint's rule of that id does not run there.
- A copy pbiplint cannot read, one with no ID, no
Scopeor a report scope, or noExpressionor one past the limit, never switches pbiplint's rule off: pbiplint's rule runs, and the copy is oneRULE_COULD_NOT_FINISHfinding, as any rule that cannot run is. Turning the id off in your config turns off both. - A copy that reads but cannot run, such as one whose expression does not parse or names a property pbiplint does not run, is an edited copy: it runs in place of pbiplint's rule as one
RULE_COULD_NOT_FINISHfinding, and pbiplint's rule of that id does not run there. Fix the copy, or delete it to have pbiplint's rule back.
A file that holds a rule with one of pbiplint's ids gets one notice, which says how many of its rules pbiplint runs as its own, which ids your team's rules replace, and how many run as the team's. Two files with the same custom id run an identical rule once; when the two rules differ, the first in customRules runs, and a notice names the other. A custom rule can never take the id PARSE_ISSUE or RULE_COULD_NOT_FINISH: such a rule cannot run, so neither of those safety nets can be replaced.
Tabular Editor's ignore annotation
Tabular Editor keeps the rules someone has dismissed in an annotation, BestPracticeAnalyzer_IgnoreRules, which Power BI Desktop keeps in the TMDL files. pbiplint honors it beside its own pbiplint.ignore, for every rule's findings on the model's objects, its own rules and your team's:
column 'Product ID'
dataType: int64
annotation BestPracticeAnalyzer_IgnoreRules = {"RuleIDs":["HIDE_FOREIGN_KEYS"]}
- On an object, it ignores the rules it names on that object.
- On the model, it ignores them on every object in the model.
- Ids and the
RuleIDskey match without regard to case, as Tabular Editor reads them. - It never hides a finding on the report, a
RULE_COULD_NOT_FINISH, or aPARSE_ISSUEfinding, since Tabular Editor reads only the model and knows nothing of what pbiplint could not read or run. Onlypbiplint.ignorehides those. - An annotation that is not a JSON object with a
RuleIDslist ignores nothing, and is onePARSE_ISSUEon its line, so it can be fixed. Tabular Editor instead fails every rule that runs on the object.
This changes results for a project that carries the annotation, whether or not it uses custom rules: the findings its authors dismissed in Tabular Editor stop appearing. On pbiplint.com it does so now; on the command line and in a self-hosted copy, from 0.4.0.
When a rule cannot run
A rule that cannot run is never skipped without a word. It is one RULE_COULD_NOT_FINISH finding, an error on the model, whose detail names the rule, its file, and the reason, as in TEAM_VISIBLE could not finish on the model: rules/team.json: Measure has no property `Visible`; `IsHidden` is the nearest. The reason names the cause from the rule's own text, never a name or a value from your model, so it can be shared to get the rule fixed.
A rule cannot run when pbiplint cannot read it: it has no ID, no Scope, a scope pbiplint does not know, or a report scope, or no Expression. A rule that reads can still fail to run: when its expression does not parse; when it names a property, function, or regular expression construct pbiplint does not run; when it needs statistics from a live model; when it reaches a limit; or when it fails on an object, such as passing an empty value to RegEx.IsMatch. A failure on one object stops the rule for the whole project, as it does in Tabular Editor. The other rules in the file still run. For a rule with one of pbiplint's ids, the two kinds differ: a copy pbiplint cannot read runs beside pbiplint's rule, and one that reads but cannot run takes its place, as above says.
The finding fails a gated run, as any error does, so a clean result means every rule ran. The cause is in the rule file, so the fix is there: the reason says what to change, and an assistant can read it and fix the rule (below). Until then, turning the rule's id off in your config, as in "TEAM_VISIBLE": "off", removes both the rule and the finding.
A property that the project's files leave unset on some objects is different. Power BI Desktop saves most calculated columns with no data type, which Tabular Editor works out from the column's DAX; a rule that reads DataType leaves those columns out rather than guess, and one notice per rule says how many it left out. pbiplint's own rules do the same.
In the output
On the command line, all of this comes with pbiplint 0.4.0. A custom finding is always labelled as your team's rule, with its file, so it never passes for one of pbiplint's.
- Text and Markdown: the rule's name and id, then
custom rule, rules/team.jsonwhere a built-in rule's page link would be; the Markdown export adds the rule's description. - JSON: the group's
rulehascustom(true),ruleFile(the file ascustomRulesnames it), anddescription; itsurlis this page, and its findings have nodetail,messageId, orparams.summary.customRuleslists each file with its rules, the copies pbiplint runs as its own, the ids it replaces, and the rules that could not run. The CLI page has every field. - SARIF: the rule's descriptor takes its name as its short description and its description as its help, with no help link, and carries
customandruleFile, as each of its results does. --quiet: a custom rule's line is like any other. An id can hold a space, which the quiet line writes as%20, so the line still splits into three fields;--ruleandexplainaccept the id either way.--rule <ID>shows a custom rule's findings, as it does a built-in rule's.pbiplint explain <ID>prints a custom rule's name, file, description, category, severity, scope, and expression, read from the nearestpbiplint.config.jsonin or above the working folder, or the one--confignames.
On this site
Drop or choose the folder that holds both the project and its rule files. The page reads pbiplint.config.json, then opens the rule files its customRules names, from inside that folder only, and nothing else in it. An entry that leads outside the folder, names a file that is not in it, or points into a folder pbiplint never opens, such as .git or node_modules, refuses the drop with a message saying why, and nothing is linted. Each finding of your team's rule is labelled "Your team's rule", with its file and its description.
The rule files run in your browser tab, like the rest of the project. The code that runs them is a file of the site's own, which the page fetches from the site once it has loaded and is idle, before you drop anything; no request follows a drop, and once the page has loaded, custom rules work with the network off. Nothing is sent anywhere and nothing is stored, so a second visit needs the folder again. The pbiplint Privacy Promise holds word for word, and its checks show it.
In your pipelines
The pbiplint Action in GitHub Actions and the pbiplint task in Azure Pipelines run the command line, which reads the project's pbiplint.config.json and the rule files it names, so custom rules need no new input: commit the rule files beside the config. They run once the step runs pbiplint 0.4.0 or later, the version the Action's pbiplint-version input or the task's pbiplintVersion input names. A rule that cannot run fails the check, as any error does. Pipelines lists what each step reads and sends.
Write a rule with an AI assistant
The format is technical, so pbiplint gives an AI assistant what it needs to write a rule and check it. On the command line, all three come with pbiplint 0.4.0:
- A skill.
pbiplint-custom-rulestakes an assistant through the loop: ask what the rule should catch, with one object that should be flagged and one that should not; read what a rule can use; write the rule, with its description; make surecustomRulesnames the file; runpbiplint <path> --rule <ID>; check it flags what was meant and nothing else; and when it givesRULE_COULD_NOT_FINISH, read the reason, fix the rule, and run it again.pbiplint skill --install claude(orcopilot,codex,gemini) writes it into your project beside pbiplint's first skill, andpbiplint skill --name pbiplint-custom-rulesprints it. The CLI page has the details. - The reference.
pbiplint referenceprints what a rule can use at the version installed, and--format jsonprints the same as data. It is the reference below, built from the same tables pbiplint runs. - MCP tools. In
pbiplint mcp,custom_rules_referencereturns the reference, andexplain_ruleandlist_rules, given apathin the project, include the custom rules its config names. The CLI page has the setup.
Severity, and any change to a rule your team already has, stay your team's call. An assistant should never turn a rule off, or change the model, to make a new rule pass.
Worked examples
Four rules a team might write, from the skill. Each is one rule, as it would sit in a rule file's array, and each flags exactly the objects named on the fixture written for them (opens in a new tab) in pbiplint's repository. The first three keep the names teams already use for these conventions, which is why they have no team prefix.
Visible names in plain words
NO_CAMELCASE_COLUMNS_HIERARCHIES catches a visible column or hierarchy named in camelCase, such as customerName, which should read Customer Name. It flags the visible column customerName and the hierarchy orderCalendar, and leaves the hidden column orderKey, the code SKU, and Order Date.
{
"ID": "NO_CAMELCASE_COLUMNS_HIERARCHIES",
"Name": "Visible columns and hierarchies are not named in camelCase",
"Category": "Naming",
"Description": "Flags a visible column or hierarchy whose name starts with a lower-case letter and runs into an upper-case one with no space between, as customerName or orderCalendar do. Hidden objects are left alone, since report readers never see their names.\n\nThe names in the field list are the names on every visual. Words with spaces, such as Customer Name, read as plain language to the people using the report, while camelCase reads as a database column carried through unchanged.\n\nRename the object in words with spaces, such as Customer Name for customerName, and check the report's visuals and any DAX that refers to it. If the name is a code the business uses as written, hide the object or ask the team whether the rule should allow it.",
"Severity": 2,
"Scope": "DataColumn, CalculatedColumn, CalculatedTableColumn, Hierarchy",
"Expression": "IsVisible and RegEx.IsMatch(Name, \"^[a-z][a-z0-9]*[A-Z]\")"
}
The pattern is anchored at the start, so a name that begins with a capital never matches.
Measures in display folders
LAYOUT_MEASURES_DF catches a measure a report reader can see that sits in no display folder. It flags Order Count, and leaves Total Sales, which is in a folder, and the hidden Sales Check.
{
"ID": "LAYOUT_MEASURES_DF",
"Name": "Visible measures sit in a display folder",
"Category": "Layout",
"Description": "Flags a visible measure with no display folder. Hidden measures are left alone, since they do not appear in the field list.\n\nFolders keep the field list short enough to scan as a model grows, and they put related measures, such as totals or ratios, where a report author expects to find them.\n\nSet the measure's display folder to the one its neighbours use, or start a new folder when none fits. If the measure is a helper no report should use, hide it instead.",
"Severity": 1,
"Scope": "Measure",
"Expression": "IsVisible and string.IsNullOrWhiteSpace(DisplayFolder)"
}
Columns and hierarchies in display folders
LAYOUT_COLUMNS_HIERARCHIES_DF is the same convention for columns and hierarchies. It flags the column Test Value and the hierarchy orderCalendar, and leaves columns in folders, hidden columns, and Order Calendar, which is in one.
{
"ID": "LAYOUT_COLUMNS_HIERARCHIES_DF",
"Name": "Visible columns and hierarchies sit in a display folder",
"Category": "Layout",
"Description": "Flags a visible column or hierarchy with no display folder. Hidden columns, such as keys, are left alone.\n\nA table's columns and hierarchies are easier to find when grouped by subject, such as Dates or Customer, and a report author can tell at a glance which fields belong together.\n\nSet the object's display folder to one its table already uses, or start a new one. If the column exists only for relationships or sorting, hide it instead.",
"Severity": 1,
"Scope": "DataColumn, CalculatedColumn, CalculatedTableColumn, Hierarchy",
"Expression": "IsVisible and string.IsNullOrWhiteSpace(DisplayFolder)"
}
Snowflake from approved schemas only
TEAM_APPROVED_SNOWFLAKE_SCHEMAS reads Power Query as text: a query that reads Snowflake must name one of the team's approved schemas, SALES or FINANCE. It flags the partition Scratch, which reads SANDBOX, and leaves the Sales partition, the shared query on FINANCE, and a partition that reads a CSV file.
{
"ID": "TEAM_APPROVED_SNOWFLAKE_SCHEMAS",
"Name": "Snowflake queries read an approved schema",
"Category": "Data sources",
"Description": "Flags a partition or shared query whose Power Query reads Snowflake but names neither of the approved schemas, SALES and FINANCE. A query that does not read Snowflake is left alone.\n\nThe approved schemas hold reviewed, governed data. A report built on a sandbox or staging schema can change or vanish without notice, and its numbers will not match the team's other reports.\n\nPoint the query at the same data in SALES or FINANCE; if it is not there yet, ask the data team to publish it. If the schema should be approved, ask the team to add it to this rule.",
"Severity": 3,
"Scope": "Partition, NamedExpression",
"Expression": "not string.IsNullOrEmpty(Expression) and Expression.Contains(\"Snowflake.Databases\") and not RegEx.IsMatch(Expression, \"Name\\s*=\\s*\"\"(SALES|FINANCE)\"\"\\s*,\\s*Kind\\s*=\\s*\"\"Schema\"\"\")"
}
The empty-expression test comes first, since a partition with no Power Query has no Expression to search, and passing an empty one to RegEx.IsMatch would stop the rule. Inside the expression a quote is doubled (""), which the JSON file holds as \"\", and a backslash in the pattern is only doubled for JSON: \\s in the file is \s in the pattern. The pattern looks for the navigation step Power BI Desktop writes, Name="SALES",Kind="Schema", so a database that happens to be called SALES does not count.
What pbiplint does not run, and why
- Statistics from a live model. A rule that reads row counts, column sizes, or the other statistics Tabular Editor keeps in a deployed model's
Vertipaq_annotations needs a deployed model, which a project's files do not hold. It is reported as needing them, never run on a guess; run it in Tabular Editor against the deployed model. The same goes for what only the server keeps, such as a table's refresh time. - Fix expressions. pbiplint reports findings and never changes your files, so a rule's
FixExpressionis ignored. - Rules stored inside a model, in its
BestPracticeAnalyzerannotation, which Tabular Editor also reads. pbiplint reads rules only from the filescustomRulesnames. - Power Query structure. A custom rule reads a query's M code as text, as Tabular Editor's rules do. It cannot follow the query's steps the way pbiplint's own Power Query rules do, because the same file must work in Tabular Editor too.
- Report rules. A Tabular Editor rule checks the semantic model; a rule whose scope is a report object cannot run. Report rules in fab-inspector's format come in a later release.
- Anything the reference does not list. A property, function, or regular expression construct the reference leaves out cannot run, and the rule says which and why. A regular expression is never run approximately: pbiplint runs the .NET constructs it can match exactly, and refuses the rest with the construct named.
Reference
Everything a Tabular Editor rule can use in the pbiplint this site runs, and what it cannot, generated from the tables pbiplint runs, so it cannot drift from them. pbiplint reference prints the same for the version you have installed. Names match without regard to case: properties, methods, scopes, keywords, and enum values. Anything not listed is not run, and a rule that uses it is one RULE_COULD_NOT_FINISH finding with the reason.
Rule fields
| Field | Use | What pbiplint does with it |
|---|---|---|
ID | Read | Required. Text, or a whole number read as its digits; it names the rule in every finding, so no two rules may share one. |
Name | Read | A short title for the rule; the ID stands in when there is none. |
Category | Read | Groups the rule in the output; Custom when there is none. |
Description | Read | What everyone who meets a finding reads: what the rule checks, why, and how to fix it. |
Severity | Read | A number, or digits in a string; see the severities below. 1 when there is none. |
Scope | Read | Required. A comma-separated list of the scopes below; the rule runs on each object of each one. |
Expression | Read | Required. The condition, as text; an object it is true for is a finding. |
IsDisabled | Read | Read, but the rule still runs, as Tabular Editor CLI runs it; turn a rule off in pbiplint.config.json instead. |
FixExpression | Ignored | pbiplint reports findings and never changes the model, so a fix is not run. |
CompatibilityLevel | Ignored | pbiplint runs the rule whatever the model's compatibility level. |
Severities
| Severity written | pbiplint reads it as |
|---|---|
| Below 0 | info |
0 | info |
1 | info |
2 | warning |
3 | error |
| 4 or more | error |
| None written | info |
Scopes
A rule's Scope names one or more of these, separated by commas; the rule runs on each object of each object type listed.
| Scope | Object types it runs on |
|---|---|
Model | Model |
Table | Table |
CalculatedTable | CalculatedTable |
Column | DataColumn, CalculatedColumn, CalculatedTableColumn |
DataColumn | DataColumn |
CalculatedColumn | CalculatedColumn |
CalculatedTableColumn | CalculatedTableColumn |
Measure | Measure |
Hierarchy | Hierarchy |
Level | Level |
Partition | Partition |
Relationship | Relationship |
Perspective | Perspective |
Culture | Culture |
ModelRole | ModelRole |
ModelRoleMember | ModelRoleMember |
TablePermission | TablePermission |
CalculationGroup | CalculationGroupTable |
CalculationItem | CalculationItem |
KPI | KPI |
NamedExpression | NamedExpression |
ProviderDataSource | ProviderDataSource |
StructuredDataSource | StructuredDataSource |
Variation | Variation |
Calendar | Calendar |
UserDefinedFunction | Function |
Properties by object type
A type marked ? may be empty (null). A type with no scope is reached from another object, as a partition's Table is.
Model
In scopes: Model.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
Relationships | Collection<Relationship> |
Roles | Collection<ModelRole> |
Perspectives | Collection<Perspective> |
Cultures | Collection<Culture> |
Expressions | Collection<NamedExpression> |
DataSources | Collection<ProviderDataSource | StructuredDataSource> |
Functions | Collection<Function> |
CalculationGroups | Collection<CalculationGroupTable> |
AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
AllMeasures | Collection<Measure> |
AllHierarchies | Collection<Hierarchy> |
AllLevels | Collection<Level> |
AllPartitions | Collection<Partition> |
AllCalculationItems | Collection<CalculationItem> |
Culture | String |
SourceQueryCulture | String |
Collation | String |
DefaultMode | ModeType |
DefaultPowerBIDataSourceVersion | PowerBIDataSourceVersion |
DiscourageImplicitMeasures | Boolean |
Table
In scopes: Table.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
DataCategory | String |
Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
Measures | Collection<Measure> |
Hierarchies | Collection<Hierarchy> |
Partitions | Collection<Partition> |
Calendars | Collection<Calendar> |
UsedInRelationships | Collection<Relationship> |
RowLevelSecurity | Indexer<String> |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
SourceExpression | String? |
ShowAsVariationsOnly | Boolean |
IsPrivate | Boolean |
LineageTag | String |
Expression | String? |
CalculatedTable
In scopes: CalculatedTable.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
DataCategory | String |
Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
Measures | Collection<Measure> |
Hierarchies | Collection<Hierarchy> |
Partitions | Collection<Partition> |
Calendars | Collection<Calendar> |
UsedInRelationships | Collection<Relationship> |
RowLevelSecurity | Indexer<String> |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
SourceExpression | String? |
ShowAsVariationsOnly | Boolean |
IsPrivate | Boolean |
LineageTag | String |
Expression | String |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
CalculationGroupTable
In scopes: CalculationGroup.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
DataCategory | String |
Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
Measures | Collection<Measure> |
Hierarchies | Collection<Hierarchy> |
Partitions | Collection<Partition> |
Calendars | Collection<Calendar> |
UsedInRelationships | Collection<Relationship> |
RowLevelSecurity | Indexer<String> |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
SourceExpression | String? |
ShowAsVariationsOnly | Boolean |
IsPrivate | Boolean |
LineageTag | String |
Expression | String? |
CalculationItems | Collection<CalculationItem> |
CalculationGroup | CalculationGroup |
CalculationGroupPrecedence | Int32 |
DataColumn
In scopes: Column, DataColumn.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
Table | Table | CalculatedTable | CalculationGroupTable |
DataType | DataType |
Type | ColumnType |
DisplayFolder | String |
FormatString | String |
DataCategory | String |
SummarizeBy | AggregateFunction |
IsKey | Boolean |
IsAvailableInMDX | Boolean |
IsNullable | Boolean |
IsUnique | Boolean |
SortByColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
UsedInSortBy | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
UsedInHierarchies | Collection<Hierarchy> |
UsedInLevels | Collection<Level> |
UsedInRelationships | Collection<Relationship> |
UsedInVariations | Collection<Variation> |
Variations | Collection<Variation> |
AlternateOf | AlternateOf |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
TranslatedDisplayFolders | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
LineageTag | String |
SourceColumn | String |
CalculatedColumn
In scopes: Column, CalculatedColumn.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
Table | Table | CalculatedTable | CalculationGroupTable |
DataType | DataType |
Type | ColumnType |
DisplayFolder | String |
FormatString | String |
DataCategory | String |
SummarizeBy | AggregateFunction |
IsKey | Boolean |
IsAvailableInMDX | Boolean |
IsNullable | Boolean |
IsUnique | Boolean |
SortByColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
UsedInSortBy | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
UsedInHierarchies | Collection<Hierarchy> |
UsedInLevels | Collection<Level> |
UsedInRelationships | Collection<Relationship> |
UsedInVariations | Collection<Variation> |
Variations | Collection<Variation> |
AlternateOf | AlternateOf |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
TranslatedDisplayFolders | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
LineageTag | String |
Expression | String |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
CalculatedTableColumn
In scopes: Column, CalculatedTableColumn.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
Table | Table | CalculatedTable | CalculationGroupTable |
DataType | DataType |
Type | ColumnType |
DisplayFolder | String |
FormatString | String |
DataCategory | String |
SummarizeBy | AggregateFunction |
IsKey | Boolean |
IsAvailableInMDX | Boolean |
IsNullable | Boolean |
IsUnique | Boolean |
SortByColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
UsedInSortBy | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
UsedInHierarchies | Collection<Hierarchy> |
UsedInLevels | Collection<Level> |
UsedInRelationships | Collection<Relationship> |
UsedInVariations | Collection<Variation> |
Variations | Collection<Variation> |
AlternateOf | AlternateOf |
ObjectLevelSecurity | Indexer<MetadataPermission> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
TranslatedDisplayFolders | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
LineageTag | String |
SourceColumn | String |
Measure
In scopes: Measure.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
Table | Table | CalculatedTable | CalculationGroupTable |
Expression | String |
FormatString | String |
FormatStringExpression | String |
DisplayFolder | String |
DataCategory | String |
DataType | DataType |
KPI | KPI |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
TranslatedDisplayFolders | Indexer<String> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
DaxObjectName | String |
DaxObjectFullName | String |
DaxTableName | String |
LineageTag | String |
KPI
In scopes: KPI.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Measure | Measure |
TargetExpression | String |
StatusExpression | String |
TrendExpression | String |
TargetFormatString | String |
TargetDescription | String |
StatusDescription | String |
TrendDescription | String |
StatusGraphic | String |
TrendGraphic | String |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
Hierarchy
In scopes: Hierarchy.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
IsHidden | Boolean |
IsVisible | Boolean |
Table | Table | CalculatedTable | CalculationGroupTable |
DisplayFolder | String |
Levels | Collection<Level> |
InPerspective | Indexer<Boolean> |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
TranslatedDisplayFolders | Indexer<String> |
LineageTag | String |
Level
In scopes: Level.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Hierarchy | Hierarchy |
Table | Table | CalculatedTable | CalculationGroupTable |
Column | DataColumn | CalculatedColumn | CalculatedTableColumn |
Ordinal | Int32 |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
LineageTag | String |
Partition
In scopes: Partition.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Table | Table | CalculatedTable | CalculationGroupTable |
SourceType | PartitionSourceType |
Mode | ModeType |
Expression | String? |
Query | String? |
DataSource | ProviderDataSource | StructuredDataSource |
Relationship
In scopes: Relationship.
| Property | Type |
|---|---|
Name | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
FromColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
ToColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
FromTable | Table | CalculatedTable | CalculationGroupTable |
ToTable | Table | CalculatedTable | CalculationGroupTable |
FromCardinality | RelationshipEndCardinality |
ToCardinality | RelationshipEndCardinality |
CrossFilteringBehavior | CrossFilteringBehavior |
SecurityFilteringBehavior | SecurityFilteringBehavior |
JoinOnDateBehavior | DateTimeRelationshipBehavior |
RelyOnReferentialIntegrity | Boolean |
IsActive | Boolean |
Perspective
In scopes: Perspective.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
TranslatedNames | Indexer<String> |
TranslatedDescriptions | Indexer<String> |
Culture
In scopes: Culture.
| Property | Type |
|---|---|
Name | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
ModelRole
In scopes: ModelRole.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Members | Collection<ModelRoleMember> |
TablePermissions | Collection<TablePermission> |
ModelPermission | ModelPermission |
RowLevelSecurity | Indexer<String> |
ModelRoleMember
In scopes: ModelRoleMember.
| Property | Type |
|---|---|
Name | String |
MemberName | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Role | ModelRole |
TablePermission
In scopes: TablePermission.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Table | Table | CalculatedTable | CalculationGroupTable |
Role | ModelRole |
Expression | String |
FilterExpression | String |
MetadataPermission | MetadataPermission |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
CalculationItem
In scopes: CalculationItem.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Expression | String |
FormatStringExpression | String |
CalculationGroup | CalculationGroupTable |
Table | CalculationGroupTable |
Ordinal | Int32 |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
NamedExpression
In scopes: NamedExpression.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Expression | String |
ProviderDataSource
In scopes: ProviderDataSource.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Type | DataSourceType |
ConnectionString | String |
UsedByPartitions | Collection<Partition> |
StructuredDataSource
In scopes: StructuredDataSource.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Type | DataSourceType |
UsedByPartitions | Collection<Partition> |
Variation
In scopes: Variation.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Column | DataColumn | CalculatedColumn | CalculatedTableColumn |
IsDefault | Boolean |
Relationship | Relationship |
DefaultHierarchy | Hierarchy |
DefaultColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
Calendar
In scopes: Calendar.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Table | Table | CalculatedTable | CalculationGroupTable |
DaxObjectName | String |
DaxObjectFullName | String |
Function
In scopes: UserDefinedFunction.
| Property | Type |
|---|---|
Name | String |
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Expression | String |
DependsOn | Collection<Dependency> |
DependsOn.Measures | Collection<Measure> |
DependsOn.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
DependsOn.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy | Collection<Object> |
ReferencedBy.Measures | Collection<Measure> |
ReferencedBy.Columns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.Tables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.AllMeasures | Collection<Measure> |
ReferencedBy.AllColumns | Collection<DataColumn | CalculatedColumn | CalculatedTableColumn> |
ReferencedBy.AllTables | Collection<Table | CalculatedTable | CalculationGroupTable> |
ReferencedBy.Roles | Collection<ModelRole> |
CalculationGroup
In no scope: reached from another object.
| Property | Type |
|---|---|
Description | String |
ObjectType | ObjectType |
ObjectTypeName | String |
Model | Model |
Precedence | Int32 |
CalculationItems | Collection<CalculationItem> |
Table | CalculationGroupTable |
AlternateOf
In no scope: reached from another object.
| Property | Type |
|---|---|
Summarization | SummarizationType |
BaseTable | Table | CalculatedTable | CalculationGroupTable |
BaseColumn | DataColumn | CalculatedColumn | CalculatedTableColumn |
Column | DataColumn | CalculatedColumn | CalculatedTableColumn |
Dependency
In no scope: reached from another object.
| Property | Type |
|---|---|
Key | Object |
Value | Collection<ObjectReference> |
ObjectReference
In no scope: reached from another object.
| Property | Type |
|---|---|
FullyQualified | Boolean |
Operators, loosest first
| Written | Precedence | What it does |
|---|---|---|
? : | 1 | test ? then : otherwise: the second value when the test is true, else the third. |
?? | 2 | The left value, or the right one when the left is null. |
|| or | 3 | True when either side is true; the right side runs only when the left is not true. |
&& and | 4 | True when both sides are true; the right side runs only when the left is not false. |
== = | 5 | Equal: strings with case, enum values by name, objects by identity. |
!= <> | 5 | Not equal, the opposite of ==. |
< | 5 | Less than: numbers, characters, enum values in order, strings in culture order. |
> | 5 | Greater than, ordered as < orders. |
<= | 5 | Less than or equal, ordered as < orders. |
>= | 5 | Greater than or equal, ordered as < orders. |
+ | 6 | Adds two numbers, or joins two strings (null counts as empty). |
- | 6 | Subtracts one number from another. |
& | 6 | Joins two values as text, turning each into a string first. |
* | 7 | Multiplies two numbers. |
/ | 7 | Divides; two whole numbers give a whole number, rounded toward zero. |
% mod | 7 | The remainder after dividing, with the sign of the left side. |
! not | 8 | True when the value is false, and false when it is true. |
- | 8 | The number with its sign changed. |
. | 9 | Reads a property or calls a method of the value before it, as in Table.Name. |
[ ] | 9 | Reads one element by position, or an indexer by name, as in TranslatedNames["fr-FR"]. |
( ) | 9 | Calls a method with its arguments, or groups part of an expression to run first. |
, | 9 | Separates the arguments of a call or an index. |
$ | 9 | The object the rule runs on, the same as it. |
Keywords
| Keyword | What it means |
|---|---|
true | The Boolean value true. |
false | The Boolean value false. |
null | No value, as a property the model leaves empty gives. |
it | The object the rule runs on; inside a condition such as Any(...), the element being tested. |
outerIt | Inside a condition, the value it was just outside it, one level up. |
current | The object the rule runs on, at any depth of conditions. |
iif | iif(test, then, otherwise): the same as test ? then : otherwise. |
not | The word form of !. |
and | The word form of &&. |
or | The word form of ||. |
mod | The word form of %. |
Literals
| Written | Type | What it means |
|---|---|---|
"Sales" | String | Text between " quotes. |
"say ""hi""" | String | A quote inside a string is doubled, so this one is say "hi". There are no backslash escapes: a backslash is itself, so "\d" is a backslash and a d. |
'a' | Char | Exactly one character between ' quotes; a ' inside one is doubled, as ''''. |
42 | Int32 | A whole number is Int32, or UInt32, Int64 or UInt64, the first it fits. |
1.5 | Double | A number with a decimal point is Double. |
2e3 | Double | A number with an exponent is Double. |
10L | Int64 | The suffix L (or l) makes the number Int64; it needs a whole number. |
10U | UInt32 | The suffix U (or u) makes the number UInt32; it needs a whole number. |
10UL | UInt64 | The suffix UL (or ul) makes the number UInt64; it needs a whole number. |
10LU | UInt64 | The suffix LU (or lu) makes the number UInt64; it needs a whole number. |
1.5F | Single | The suffix F (or f) makes the number Single. |
1.5D | Double | The suffix D (or d) makes the number Double. |
1.5M | Decimal | The suffix M (or m) makes the number Decimal. |
@it | name | @ before a name makes it a property even when it is a keyword or a type name, so @it is a property named it. |
Empty values
A property marked ? can be empty (null). Reading a property of an empty value, calling a method on it, or indexing it gives no finding for that object, and the rule goes on to the next object; passing an empty value to a function, as in RegEx.IsMatch(Expression, ...), stops the rule. Otherwise an empty value follows .NET's rules: == null tests for one, + joins it to text as empty text, arithmetic on it gives an empty value, and a condition that comes out empty gives no finding.
Methods by value type
String
| Method or property | What it gives |
|---|---|
Length: Int32 | How many characters the string has. |
Contains(value: String): Boolean | Whether the string holds the value, matching case exactly. |
Contains(value: Char): Boolean | Whether the string holds the character. |
Contains(value: String, comparison: StringComparison): Boolean | Whether the string holds the value, ignoring case if the comparison says so. |
StartsWith(value: String): Boolean | Whether the string begins with the value, matching case exactly. |
StartsWith(value: Char): Boolean | Whether the string begins with the character. |
StartsWith(value: String, comparison: StringComparison): Boolean | Whether the string begins with the value, ignoring case if the comparison says so. |
EndsWith(value: String): Boolean | Whether the string ends with the value, matching case exactly. |
EndsWith(value: Char): Boolean | Whether the string ends with the character. |
EndsWith(value: String, comparison: StringComparison): Boolean | Whether the string ends with the value, ignoring case if the comparison says so. |
IndexOf(value: String): Int32 | Where the value first appears, counting from 0, or -1; case must match. |
IndexOf(value: Char): Int32 | Where the character first appears, counting from 0, or -1. |
IndexOf(value: String, comparison: StringComparison): Int32 | Where the value first appears, or -1, ignoring case if the comparison says so. |
IndexOf(value: String, startIndex: Int32): Int32 | Where the value first appears at or after the start index, or -1. |
IndexOf(value: Char, startIndex: Int32): Int32 | Where the character first appears at or after the start index, or -1. |
LastIndexOf(value: String): Int32 | Where the value last appears, counting from 0, or -1; case must match. |
LastIndexOf(value: Char): Int32 | Where the character last appears, counting from 0, or -1. |
LastIndexOf(value: String, comparison: StringComparison): Int32 | Where the value last appears, or -1, ignoring case if the comparison says so. |
Replace(oldValue: String, newValue: String): String | The string with every occurrence of one value replaced by another, matching case exactly. |
Replace(oldChar: Char, newChar: Char): String | The string with every occurrence of one character replaced by another. |
Substring(startIndex: Int32): String | The string from the start index to its end; fails the rule past the end. |
Substring(startIndex: Int32, length: Int32): String | That many characters from the start index; fails the rule past the end. |
ToUpper(): String | The string in upper case, one character at a time. |
ToLower(): String | The string in lower case, one character at a time. |
ToUpperInvariant(): String | The string in upper case, the same in every culture. |
ToLowerInvariant(): String | The string in lower case, the same in every culture. |
Trim(): String | The string without white space at either end. |
TrimStart(): String | The string without white space at its start. |
TrimEnd(): String | The string without white space at its end. |
ToCharArray(): Collection<Char> | The string's characters, for a condition on each one. |
Split(separator: Char): Collection<String> | The parts of the string between each separator character. |
Split(separator: String): Collection<String> | The parts of the string between each separator. |
Equals(value: String): Boolean | Whether the two strings are the same, matching case exactly. |
Equals(value: String, comparison: StringComparison): Boolean | Whether the two strings are the same, ignoring case if the comparison says so. |
CompareTo(value: String): Int32 | -1, 0 or 1 as the string sorts before, with, or after the value, in culture order. |
ToString(): String | The string itself. |
Collection
| Method or property | What it gives |
|---|---|
Count: Int32 | How many elements the collection has. |
Any(): Boolean | Whether the collection has any element. |
Any(condition: Predicate): Boolean | Whether the condition holds for at least one element. |
All(condition: Predicate): Boolean | Whether the condition holds for every element (true for an empty collection). |
Count(): Int32 | How many elements there are. |
Count(condition: Predicate): Int32 | How many elements the condition holds for. |
LongCount(): Int64 | How many elements there are. |
LongCount(condition: Predicate): Int64 | How many elements the condition holds for. |
Where(condition: Predicate): Collection<T> | The elements the condition holds for. |
Select(selector: Selector): Collection<Selector> | The selector's value for each element. |
First(): T | The first element; fails the rule on an empty collection. |
First(condition: Predicate): T | The first element the condition holds for; fails the rule if there is none. |
FirstOrDefault(): T? | The first element, or null for an empty collection. |
FirstOrDefault(condition: Predicate): T? | The first element the condition holds for, or null. |
Last(): T | The last element; fails the rule on an empty collection. |
Last(condition: Predicate): T | The last element the condition holds for; fails the rule if there is none. |
LastOrDefault(): T? | The last element, or null for an empty collection. |
LastOrDefault(condition: Predicate): T? | The last element the condition holds for, or null. |
Sum(): Number | The numbers added up (0 for an empty collection). |
Sum(selector: Selector): Number | The selector's numbers added up (0 for an empty collection). |
Max(): T | The largest element; fails the rule on an empty collection. |
Max(selector: Selector): Selector | The selector's largest value; fails the rule on an empty collection. |
Min(): T | The smallest element; fails the rule on an empty collection. |
Min(selector: Selector): Selector | The selector's smallest value; fails the rule on an empty collection. |
Average(): Double | The mean of the numbers; fails the rule on an empty collection. |
Average(selector: Selector): Double | The mean of the selector's numbers; fails the rule on an empty collection. |
Contains(value: T): Boolean | Whether the collection holds the value. |
Distinct(): Collection<T> | The elements with repeats removed, first ones kept. |
OrderBy(selector: Selector): Collection<T> | The elements sorted by the selector's value, smallest first. |
OrderByDescending(selector: Selector): Collection<T> | The elements sorted by the selector's value, largest first. |
Skip(count: Int32): Collection<T> | The elements after the first few. |
Take(count: Int32): Collection<T> | The first few elements. |
ToList(): Collection<T> | The same elements, as a list. |
ToArray(): Collection<T> | The same elements, as an array. |
Char
| Method or property | What it gives |
|---|---|
ToString(): String | The character as text, as .NET prints it. |
Equals(value: Object): Boolean | Whether the character equals the value. |
CompareTo(value: Char): Int32 | -1, 0 or 1 as the character's code is below, equal to, or above the other's. |
Number
| Method or property | What it gives |
|---|---|
ToString(): String | The number as text, as .NET prints it. |
Equals(value: Object): Boolean | Whether the number equals the value. |
CompareTo(value: Number): Int32 | -1, 0 or 1 as the number is below, equal to, or above the value. |
Boolean
| Method or property | What it gives |
|---|---|
ToString(): String | The value as text, as .NET prints it. |
Equals(value: Object): Boolean | Whether the value equals the value. |
Enum
| Method or property | What it gives |
|---|---|
ToString(): String | The enum value as text, as .NET prints it. |
Equals(value: Object): Boolean | Whether the enum value equals the value. |
Object
| Method or property | What it gives |
|---|---|
GetAnnotation(name: String): String? | The object's annotation of that name, or null when it has none. |
HasAnnotation(name: String): Boolean | Whether the object has an annotation of that name. |
Tokenize(): Collection<DaxToken> | The tokens of the object's DAX, comments and white space included, each with Type, Text and Next. |
Static functions and values
| Function or value | What it gives |
|---|---|
String.IsNullOrEmpty(value: String): Boolean | Whether the string is null or has no characters. |
String.IsNullOrWhiteSpace(value: String): Boolean | Whether the string is null, empty, or only white space; names match without regard to case, so IsNullOrWhitespace is the same. |
String.Concat(a: String, b: String): String | The strings joined end to end; null counts as empty. |
String.Concat(a: String, b: String, c: String): String | The strings joined end to end; null counts as empty. |
String.Join(separator: String, values: Collection<String>): String | The strings of a collection joined with the separator between each. |
String.Compare(a: String, b: String): Int32 | -1, 0 or 1 as the first string sorts before, with, or after the second, in culture order. |
String.Equals(a: String, b: String): Boolean | Whether the two strings are the same, matching case exactly. |
Char.IsWhiteSpace(c: Char): Boolean | Whether the character is white space, as .NET defines it. |
Char.IsLetter(c: Char): Boolean | Whether the character is a letter, in any script. |
Char.IsDigit(c: Char): Boolean | Whether the character is a decimal digit, in any script. |
Char.IsLetterOrDigit(c: Char): Boolean | Whether the character is a letter or a decimal digit. |
Char.IsUpper(c: Char): Boolean | Whether the character is an upper-case letter. |
Char.IsLower(c: Char): Boolean | Whether the character is a lower-case letter. |
Char.IsControl(c: Char): Boolean | Whether the character is a control character, such as a tab or a line break. |
Char.IsPunctuation(c: Char): Boolean | Whether the character is punctuation. |
Char.IsNumber(c: Char): Boolean | Whether the character is a digit or other number character. |
Char.IsSymbol(c: Char): Boolean | Whether the character is a symbol, such as a currency sign. |
Char.IsSeparator(c: Char): Boolean | Whether the character is a space or other separator. |
Char.ToUpper(c: Char): Char | The character in upper case. |
Char.ToLower(c: Char): Char | The character in lower case. |
Convert.ToInt32(value: Object): Int32 | A whole number from a string, number, character or true/false; null gives 0; anything else fails the rule. |
Convert.ToInt64(value: Object): Int64 | A whole number from a string, number, character or true/false; null gives 0; anything else fails the rule. |
Convert.ToDecimal(value: Object): Decimal | A decimal number from a string or number; null gives 0; anything else fails the rule. |
Convert.ToDouble(value: Object): Double | A double from a string or number; null gives 0; anything else fails the rule. |
Convert.ToString(value: Object): String | The value as text, as .NET prints it; null gives an empty string. |
Convert.ToBoolean(value: Object): Boolean | True or false from the text True or False (any case) or a number (0 is false); anything else fails the rule. |
Convert.ToChar(value: Object): Char | The character with a code (Convert.ToChar(10) is a line feed), or the one character of a string. |
Math.Max(a: Number, b: Number): Number | The larger of two numbers; a double if either is. |
Math.Min(a: Number, b: Number): Number | The smaller of two numbers; a double if either is. |
Math.Abs(value: Number): Number | The number without its sign. |
Math.Round(value: Number): Double | The nearest whole number, halves to the even one, as .NET rounds. |
Math.Round(value: Number, digits: Int32): Double | The number rounded to that many decimal places, halves to the even one. |
Math.Floor(value: Number): Double | The largest whole number not above the value. |
Math.Ceiling(value: Number): Double | The smallest whole number not below the value. |
Regex.IsMatch(input: String, pattern: String): Boolean | Whether the .NET regular expression matches anywhere in the input; also spelled RegEx. Fails the rule on a null input or a pattern that does not compile. |
Regex.IsMatch(input: String, pattern: String, options: RegexOptions): Boolean | The same, with RegexOptions.IgnoreCase or RegexOptions.None; any other option stops the rule. |
String.Empty: String | The empty string. |
Conversions
| Type | Written |
|---|---|
Char | Char(...) |
SByte | SByte(...) |
Byte | Byte(...) |
Int16 | Int16(...) or short(...) |
UInt16 | UInt16(...) or ushort(...) |
Int32 | Int32(...) or int(...) |
UInt32 | UInt32(...) or uint(...) |
Int64 | Int64(...) or long(...) |
UInt64 | UInt64(...) or ulong(...) |
Single | Single(...) or float(...) |
Double | Double(...) |
Decimal | Decimal(...) |
Enums
| Enum | Values | What it is |
|---|---|---|
DataType | Automatic, String, Int64, Double, DateTime, Decimal, Boolean, Binary, Unknown, Variant | The values of the model's DataType property, by name. |
AggregateFunction | Default, None, Sum, Min, Max, Count, Average, DistinctCount | The values of the model's AggregateFunction property, by name. |
CrossFilteringBehavior | OneDirection, BothDirections, Automatic | The values of the model's CrossFilteringBehavior property, by name. |
RelationshipEndCardinality | None, One, Many | The values of the model's RelationshipEndCardinality property, by name. |
SecurityFilteringBehavior | OneDirection, BothDirections, None | The values of the model's SecurityFilteringBehavior property, by name. |
DateTimeRelationshipBehavior | DateAndTime, DatePartOnly | The values of the model's DateTimeRelationshipBehavior property, by name. |
PartitionSourceType | Query, Calculated, None, M, Entity, PolicyRange, CalculationGroup, Inferred, Parquet | The values of the model's PartitionSourceType property, by name. |
ModeType | Import, DirectQuery, Default, Push, Dual, DirectLake | The values of the model's ModeType property, by name. |
ColumnType | Data, Calculated, RowNumber, CalculatedTableColumn | The values of the model's ColumnType property, by name. |
DataSourceType | Provider, Structured | The values of the model's DataSourceType property, by name. |
MetadataPermission | Default, None, Read | The values of the model's MetadataPermission property, by name. |
ModelPermission | None, Read, ReadRefresh, Refresh, Administrator | The values of the model's ModelPermission property, by name. |
PowerBIDataSourceVersion | PowerBI_V1, PowerBI_V2, PowerBI_V3 | The values of the model's PowerBIDataSourceVersion property, by name. |
SummarizationType | GroupBy, Sum, Count, Min, Max | The values of the model's SummarizationType property, by name. |
ObjectType | Model, DataSource, Table, CalculationGroupTable, Column, Partition, Relationship, Measure, Hierarchy, Level, KPI, Culture, Perspective, Role, RoleMember, TablePermission, Variation, Expression, CalculationGroup, CalculationItem, Calendar, Function | The values of the model's ObjectType property, by name. |
StringComparison | CurrentCulture, CurrentCultureIgnoreCase, InvariantCulture, InvariantCultureIgnoreCase, Ordinal, OrdinalIgnoreCase | How IndexOf, Contains, StartsWith, EndsWith and Equals compare: ordinal, or ignoring case. |
RegexOptions | None, IgnoreCase, Multiline, ExplicitCapture, Compiled, Singleline, IgnorePatternWhitespace, RightToLeft, ECMAScript, CultureInvariant, NonBacktracking | Options for RegEx.IsMatch; pbiplint runs IgnoreCase and None. pbiplint runs only None and IgnoreCase. |
Tokenize()
Each token Tokenize() gives has these members.
| Member | Type | What it is |
|---|---|---|
Type | Int32 | The token's type, as a code to compare with a type name: Type == STRING_LITERAL. A type named as a keyword or a .NET type of the expression, such as NOT, TRUE or CONVERT, does not read as the token type there; compare Text.ToUpper() instead. |
Text | String | The token's text; for a string literal, its content without the quotes. |
Next | DaxToken? | The next token that is neither white space nor a comment, or null at the end. |
The token types, by name:
SINGLE_LINE_COMMENT, DELIMITED_COMMENT, WHITESPACES, DATE_LITERAL, INTEGER_LITERAL, REAL_LITERAL, STRING_LITERAL, TABLE, COLUMN_OR_MEASURE, TABLE_OR_VARIABLE, OPEN_CURLY, CLOSE_CURLY, OPEN_PARENS, CLOSE_PARENS, COMMA, PLUS, MINUS, STAR, DIV, CARET, AMP, LT, GT, OP_AND, OP_OR, OP_NE, OP_LE, OP_GE, LAMBDA, COLON, EQ, VAR, RETURN, IN, DEFINE, EVALUATE, ORDER, BY, ASC, DESC, START, AT, MEASURE, COLUMN, NOT, TRUE, FALSE, AND, OR, ABS, ACCRINT, ACCRINTM, ACOS, ACOSH, ACOT, ACOTH, ADDCOLUMNS, ADDMISSINGITEMS, ALL, ALLCROSSFILTERED, ALLEXCEPT, ALLNOBLANKROW, ALLSELECTED, AMORDEGRC, AMORLINC, APPROXIMATEDISTINCTCOUNT, ASIN, ASINH, ATAN, ATANH, AVERAGE, AVERAGEA, AVERAGEX, BITAND, BITLSHIFT, BITOR, BITRSHIFT, BITXOR, BLANK, CALCULATE, CALCULATETABLE, CALENDAR, CALENDARAUTO, CEILING, CHISQ, CLOSINGBALANCEMONTH, CLOSINGBALANCEQUARTER, CLOSINGBALANCEYEAR, COALESCE, COLUMNSTATISTICS, COMBIN, COMBINA, COMBINEVALUES, CONCATENATE, CONCATENATEX, CONFIDENCE, CONTAINS, CONTAINSROW, CONTAINSSTRING, CONTAINSSTRINGEXACT, CONVERT, COS, COSH, COT, COTH, COUNT, COUNTA, COUNTAX, COUNTBLANK, COUNTROWS, COUNTX, COUPDAYBS, COUPDAYS, COUPDAYSNC, COUPNCD, COUPNUM, COUPPCD, CROSSFILTER, CROSSJOIN, CUMIPMT, CUMPRINC, CURRENCY, CURRENTGROUP, CUSTOMDATA, DATATABLE, DATE, DATEADD, DATEDIFF, DATESBETWEEN, DATESINPERIOD, DATESMTD, DATESQTD, DATESYTD, DATEVALUE, DAY, DB, DDB, DEGREES, DETAILROWS, DISC, DISTINCT, DISTINCTCOUNT, DISTINCTCOUNTNOBLANK, DIVIDE, DOLLARDE, DOLLARFR, DURATION, EARLIER, EARLIEST, EDATE, EFFECT, ENDOFMONTH, ENDOFQUARTER, ENDOFYEAR, EOMONTH, ERROR, EVALUATEANDLOG, EVEN, EXACT, EXCEPT, EXP, EXPON, EXTERNALMEASURE, FACT, FILTER, FILTERS, FIND, FIRST, FIRSTDATE, FIRSTNONBLANK, FIRSTNONBLANKVALUE, FIXED, FLOOR, FORMAT, FV, GCD, GENERATE, GENERATEALL, GENERATESERIES, GEOMEAN, GEOMEANX, GROUPBY, HASONEFILTER, HASONEVALUE, HOUR, IF, IFERROR, IGNORE, INDEX, INFO, INT, INTERSECT, INTRATE, IPMT, ISAFTER, ISBLANK, ISCROSSFILTERED, ISEMPTY, ISERROR, ISEVEN, ISFILTERED, ISINSCOPE, ISLOGICAL, ISNONTEXT, ISNUMBER, ISO, ISODD, ISONORAFTER, ISPMT, ISSELECTEDMEASURE, ISSUBTOTAL, ISTEXT, KEEPFILTERS, LAST, LASTDATE, LASTNONBLANK, LASTNONBLANKVALUE, LCM, LEFT, LEN, LINEST, LINESTX, LN, LOG, LOG10, LOOKUP, LOOKUPVALUE, LOWER, MATCHBY, MAX, MAXA, MAXX, MDURATION, MEDIAN, MEDIANX, MID, MIN, MINA, MINUTE, MINX, MOD, MONTH, MOVINGAVERAGE, MROUND, NATURALINNERJOIN, NATURALLEFTOUTERJOIN, NETWORKDAYS, NEXT, NEXTDAY, NEXTMONTH, NEXTQUARTER, NEXTYEAR, NOMINAL, NONVISUAL, NOW, NPER, OCT, ODD, ODDFPRICE, ODDFYIELD, ODDLPRICE, ODDLYIELD, OFFSET, OPENINGBALANCEMONTH, OPENINGBALANCEQUARTER, OPENINGBALANCEYEAR, ORDERBY, PARALLELPERIOD, PARTITIONBY, PATH, PATHCONTAINS, PATHITEM, PATHITEMREVERSE, PATHLENGTH, PDURATION, PERMUT, PI, PMT, POWER, PPMT, PREVIOUS, PREVIOUSDAY, PREVIOUSMONTH, PREVIOUSQUARTER, PREVIOUSYEAR, PRICE, PRICEDISC, PRICEMAT, PRODUCT, PRODUCTX, PV, QUARTER, QUOTIENT, RADIANS, RAND, RANDBETWEEN, RANGE, RANK, RANKX, RATE, RECEIVED, RELATED, RELATEDTABLE, REMOVEFILTERS, REPLACE, REPT, RIGHT, ROLLUP, ROLLUPADDISSUBTOTAL, ROLLUPGROUP, ROLLUPISSUBTOTAL, ROUND, ROUNDDOWN, ROUNDUP, ROW, ROWNUMBER, RRI, RUNNINGSUM, SAMEPERIODLASTYEAR, SAMPLE, SEARCH, SECOND, SELECTCOLUMNS, SELECTEDMEASURE, SELECTEDMEASUREFORMATSTRING, SELECTEDMEASURENAME, SELECTEDVALUE, SIGN, SIN, SINH, SLN, SQRT, SQRTPI, STARTOFMONTH, STARTOFQUARTER, STARTOFYEAR, SUBSTITUTE, SUBSTITUTEWITHINDEX, SUM, SUMMARIZE, SUMMARIZECOLUMNS, SUMX, SWITCH, SYD, TAN, TANH, TBILLEQ, TBILLPRICE, TBILLYIELD, TIME, TIMEVALUE, TOCSV, TODAY, TOJSON, TOPN, TOPNSKIP, TOTALMTD, TOTALQTD, TOTALYTD, TREATAS, TRIM, TRUNC, UNICHAR, UNICODE, UNION, UPPER, USERCULTURE, USERELATIONSHIP, USERNAME, USEROBJECTID, USERPRINCIPALNAME, UTCNOW, UTCTODAY, VALUE, VALUES, VDB, WEEKDAY, WEEKNUM, WINDOW, XIRR, XNPV, YEAR, YEARFRAC, YIELD, YIELDDISC, YIELDMAT
Regular expressions
These constructs run, each with an example pattern, a text it matches, and one it does not.
| Construct | Pattern | Matches | Does not match |
|---|---|---|---|
| Literal text | "Sales" | "Total Sales" | "sales" |
., any character but a line feed | "a.c" | "abc" | "a\u000ac" |
|, either side | "Sum|Total" | "Total Cost" | "Cost" |
A group, (...) or (?:...), to repeat or choose within | "(?:ab)+c" | "ababc" | "ac" |
A named group, (?<name>...) or (?'name'...) | "(?<year>\d{4})-" | "2026-11" | "26-11" |
*, none or more | "ab*c" | "ac" | "adc" |
+, one or more | "ab+c" | "abbc" | "ac" |
?, none or one | "colou?r" | "color" | "colouur" |
{n}, {n,} and {n,m}, a counted repeat | "^\d{2,4}$" | "123" | "12345" |
A lazy repeat such as *?, which matches where the greedy one does | "a.*?b" | "axxb" | "axx" |
^ and $, the start and the end (or just before a final line feed) | "^Sales$" | "Sales" | "Sales Tax" |
\A, \z and \Z, the start, the very end, and the end or before a final line feed | "\ASales\z" | "Sales" | "Sales\u000a" |
\b and \B, a word boundary and its opposite | "\bID\b" | "Customer ID" | "IDENTITY" |
A class, [...], with ranges such as a-z | "^[A-Z][a-z]+$" | "Sales" | "sales" |
A negated class, [^...] | "^[^0-9]+$" | "Sales" | "Q4" |
\d, \w and \s, with \D, \W and \S for their opposites, as Unicode defines them | "\w+\s\d" | "Quarter 4" | "Quarter" |
\p{...} and \P{...}, a Unicode general category such as Lu | "^\p{Lu}" | "Sales" | "sales" |
Escapes such as \t, \n, \x41, \u0041 and \. | "\x41\u0042\." | "AB." | "AB!" |
(?i), ignoring case from there on, and (?i:...) within a group | "(?i)total" | "TOTAL" | "tot al" |
A lookaround one character or one class wide, such as (?=u) or (?<!_) | "(?<!_)id" | "Customer id" | "_id" |
A comment, (?#...) | "a(?#note)b" | "ab" | "a b" |
These are refused, and a rule that uses one stops with the reason.
| Construct | Pattern | Reason |
|---|---|---|
An atomic group, (?>...) | "(?>ab|a)c" | an atomic group (?>...) cannot be translated exactly |
A conditional, (?(...)yes|no) | "(?(a)b|c)" | a conditional (?(...)yes|no) cannot be run |
A balancing group, (?<name-other>...) | "(?<o>a)(?<c-o>b)" | a balancing group (?<name-other>...) cannot be run |
The inline options (?m), (?n), (?s) and (?x), and the RegexOptions they stand for | "(?m)^Total" | the inline option (?m) cannot be run; pbiplint runs only (?i) |
A lookaround wider than one character or one class, such as (?=ab) | "Total(?=ab)" | (?=...) wider than one character or one class cannot be translated exactly |
\G, where the last match ended | "\Ga" | the anchor \G cannot be run |
A backreference, \1 or \k<name> | "(a)\1" | a backreference (\1, \k<name>) cannot be run in linear time |
A Unicode block, such as \p{IsGreek} | "\p{IsGreek}" | the Unicode block \p{IsGreek} cannot be run |
\p{Lu}, \p{Ll} or \p{Lt} while case is ignored | "(?i)\p{Lu}" | \p{Lu} under (?i) cannot be translated exactly |
[:name:] inside a class | "[[:alpha:]]" | [:name:] inside a class cannot be translated exactly |
A class subtraction, [...-[...]] | "[a-z-[aeiou]]" | a class subtraction [...-[...]] cannot be translated exactly |
Not run, and why
A rule that uses one of these is one RULE_COULD_NOT_FINISH finding, with this reason.
| What the rule uses | Kind | Reason |
|---|---|---|
Vertipaq_Cardinality | annotation | reads Vertipaq_Cardinality, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Vertipaq_RowCount | annotation | reads Vertipaq_RowCount, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Vertipaq_RIViolationInvalidRows | annotation | reads Vertipaq_RIViolationInvalidRows, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Vertipaq_TableSize | annotation | reads Vertipaq_TableSize, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Vertipaq_ColumnSize | annotation | reads Vertipaq_ColumnSize, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Vertipaq_TotalSize | annotation | reads Vertipaq_TotalSize, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
LongLengthRowCount | annotation | reads LongLengthRowCount, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
DateTimeWithHourMinSec | annotation | reads DateTimeWithHourMinSec, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
State | property | reads State, which is kept by the server for a deployed model and is not in a project's files |
ErrorMessage | property | reads ErrorMessage, which is kept by the server for a deployed model and is not in a project's files |
RefreshedTime | property | reads RefreshedTime, which is kept by the server for a deployed model and is not in a project's files |
ModifiedTime | property | reads ModifiedTime, which is kept by the server for a deployed model and is not in a project's files |
StructureModifiedTime | property | reads StructureModifiedTime, which is kept by the server for a deployed model and is not in a project's files |
Vertipaq_* | annotation | reads Vertipaq_*, which needs statistics from a live model that a project's files do not hold; run the rule in Tabular Editor against a deployed model |
Page | scope | The rule's Scope names a report object (Page). Tabular Editor's rules check the semantic model; report rules use fab-inspector's format. |
Visual | scope | The rule's Scope names a report object (Visual). Tabular Editor's rules check the semantic model; report rules use fab-inspector's format. |
CustomVisual | scope | The rule's Scope names a report object (CustomVisual). Tabular Editor's rules check the semantic model; report rules use fab-inspector's format. |
Filter | scope | The rule's Scope names a report object (Filter). Tabular Editor's rules check the semantic model; report rules use fab-inspector's format. |
Report | scope | The rule's Scope names a report object (Report). Tabular Editor's rules check the semantic model; report rules use fab-inspector's format. |
CalculationGroupTable | scope | The rule's Scope names a scope Tabular Editor does not define: CalculationGroupTable. For CalculationGroupTable, use CalculationGroup. Scope is a comma-separated list of names such as Model, Table, Column, Measure, Partition, or Relationship. |
Function | scope | The rule's Scope names a scope Tabular Editor does not define: Function. For Function, use UserDefinedFunction. Scope is a comma-separated list of names such as Model, Table, Column, Measure, Partition, or Relationship. |
Role | scope | The rule's Scope names a scope Tabular Editor does not define: Role. For Role, use ModelRole. Scope is a comma-separated list of names such as Model, Table, Column, Measure, Partition, or Relationship. |
DataSource | scope | The rule's Scope names a scope Tabular Editor does not define: DataSource. For DataSource, use ProviderDataSource. Scope is a comma-separated list of names such as Model, Table, Column, Measure, Partition, or Relationship. |
Expression | scope | The rule's Scope names a scope Tabular Editor does not define: Expression. For Expression, use NamedExpression. Scope is a comma-separated list of names such as Model, Table, Column, Measure, Partition, or Relationship. |
x => ... | syntax | a named lambda parameter ('x => ...'), which Tabular Editor does not run; write the body with 'it' instead |
Object(...) | syntax | converting to Object with Object(...) is not supported; use Convert |
Boolean(...) | syntax | converting to Boolean with Boolean(...) is not supported; use Convert |
String(...) | syntax | converting to String with String(...) is not supported; use Convert |
DateTime(...) | syntax | converting to DateTime with DateTime(...) is not supported; use Convert |
DateTimeOffset(...) | syntax | converting to DateTimeOffset with DateTimeOffset(...) is not supported; use Convert |
TimeSpan(...) | syntax | converting to TimeSpan with TimeSpan(...) is not supported; use Convert |
Guid(...) | syntax | converting to Guid with Guid(...) is not supported; use Convert |
.Single(...) | syntax | collection has no method Single |
.SingleOrDefault(...) | syntax | collection has no method SingleOrDefault |
.SelectMany(...) | syntax | collection has no method SelectMany |
.ThenBy(...) | syntax | collection has no method ThenBy |
.ThenByDescending(...) | syntax | collection has no method ThenByDescending |
.TakeWhile(...) | syntax | collection has no method TakeWhile |
.SkipWhile(...) | syntax | collection has no method SkipWhile |
.GroupBy(...) | syntax | collection has no method GroupBy |
.DistinctBy(...) | syntax | collection has no method DistinctBy |
RegexOptions.Multiline | option | RegEx.IsMatch was given RegexOptions.Multiline, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.ExplicitCapture | option | RegEx.IsMatch was given RegexOptions.ExplicitCapture, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.Compiled | option | RegEx.IsMatch was given RegexOptions.Compiled, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.Singleline | option | RegEx.IsMatch was given RegexOptions.Singleline, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.IgnorePatternWhitespace | option | RegEx.IsMatch was given RegexOptions.IgnorePatternWhitespace, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.RightToLeft | option | RegEx.IsMatch was given RegexOptions.RightToLeft, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.ECMAScript | option | RegEx.IsMatch was given RegexOptions.ECMAScript, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.CultureInvariant | option | RegEx.IsMatch was given RegexOptions.CultureInvariant, which pbiplint does not run; only IgnoreCase and None are |
RegexOptions.NonBacktracking | option | RegEx.IsMatch was given RegexOptions.NonBacktracking, which pbiplint does not run; only IgnoreCase and None are |
FixExpression | field | pbiplint reports findings and never changes the model, so a fix is not run. |
CompatibilityLevel | field | pbiplint runs the rule whatever the model's compatibility level. |
Limits
| Limit | Value | What it holds |
|---|---|---|
fileBytes | 1,048,576 | The most bytes a rule file may hold; a larger file stops the project's lint, naming it. |
rulesPerFile | 2,000 | The most rules read from one file; each rule after that is reported as not read. |
expressionChars | 20,000 | The longest Expression, in characters; a longer one is reported as not read. |
nesting | 100 | How deeply an Expression, or the groups of a regular expression, may nest; deeper stops the rule. |
patternChars | 4,000 | The longest regular expression, in characters; a longer one stops the rule. |
patternStates | 10,000 | The most states a regular expression may compile to; large repeat counts such as {1000} reach it, and it stops the rule. |
stepsPerRule | 20,000,000 | The evaluation steps one rule may take over the whole model, regular expressions included; a rule that reaches it stops. |