Skip to content

BSL189 — Metadata object has a forbidden name

← All rules

Summary

Metadata object has a forbidden name

Identifiers

Field Value
Rule code BSL189
Compatible alias ForbiddenMetadataName
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags naming, convention

Behavior

  • The public identifier BSL189 and alias ForbiddenMetadataName are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL189"]
ignore = ["ForbiddenMetadataName"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL189
  • bsl-disable:
Value = "example";  // bsl-disable: BSL189
  • compatible BSLLS form:
Value = "example";  // BSLLS:ForbiddenMetadataName-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL189
// code without this diagnostic
// noqa-enable: BSL189

// bsl-disable: BSL189
// code without this diagnostic
// bsl-enable: BSL189

// BSLLS:ForbiddenMetadataName-off
// code without this diagnostic
// BSLLS:ForbiddenMetadataName-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

It is forbidden to use the names of metadata objects (and their attributes and tabular sections), which are used when naming query tables (for example, Document, Catalog).

Using such names can lead to errors in the execution of the query, and also make it difficult to use the query designer and reduce the clarity of the query text.

Examples

Wrong name - Catalog.Catalog - Catalog.MyCatalog.Attribute.Document - InformationRegister.MyRegister.Dimension.Documents

Sources