Skip to content

BSL220 — Multi-line literal in query

← All rules

Summary

Multi-line literal in query

Identifiers

Field Value
Rule code BSL220
Compatible alias MultilineStringInQuery
Severity INFORMATION
Enabled by default Yes
Implemented Yes
Tags query, style

Behavior

  • The public identifier BSL220 and alias MultilineStringInQuery 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 = ["BSL220"]
ignore = ["MultilineStringInQuery"]

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: BSL220
  • bsl-disable:
Value = "example";  // bsl-disable: BSL220
  • compatible BSLLS form:
Value = "example";  // BSLLS:MultilineStringInQuery-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: BSL220
// code without this diagnostic
// noqa-enable: BSL220

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

// BSLLS:MultilineStringInQuery-off
// code without this diagnostic
// BSLLS:MultilineStringInQuery-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

Multi-line literals are rarely used in query texts, mostly these are error results due to an incorrect number of double quotes.

Examples

In the example below, the selection will have two fields instead of three.

Query = New Query;
Query.Text = "SELECT
|   OrderGoods.Cargo AS Cargo,
|   ISNULL(OrderGoods.Cargo.Code, "") AS CargoCode, // quote error here, should be """"
|   ISNULL(OrderGoods.Cargo.Name, "") AS CargoName
|FROM
|   Document.Order.Goods AS OrderGoods
|WHERE
|   OrderGoods.Ref = &Ref";

Sources