Added support for DQLPart language (#123)

dorian-krefft-dt · web-flow · commit e860fb259116 · 2026-02-08T18:48:41.000+01:00
* Added support for DQLPart language

The language is a better option than the DQL file name part as it is much easier to disable some parts of the language feature support when the file type is different.

* Resolving code review issues

* Resolving code review issues

* Resolving code review issues
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,13 +21,21 @@
   - All code style & highlighting settings will be inherited from the DQL language.
   - All suitable DQL inspections will be applied to the expression, allowing the user to validate them.
   - Code completion and hover documentation are also supported.
+- Adding support for the "Partial DQL" file type (with `.dqlpart` extension). This language works similar to
+  the previous `.partial.dql` files, but allows for an easier separation from the normal DQL file.
+  - Added a quick fix to migrate from the old `.partial.dql` suffix to the new `.dqlpart` extension.
+  - Works exactly like a normal DQL file, but allows to use non-starting commands like `filter` or `sort` as the first
+    statement in the query, without causing an error.
+  - An example `file.dqlpart` file: `filter field > 10 | sort field desc`
+  - Support for `.partial.dql` files will be removed in the future, so it's recommended to migrate to the new extension
+    as soon as possible.
 - **Breaking**: Changing the approach to the default Dynatrace tenant used for connections - it will be the first tenant
   specified in the list (previously the user needed to specifically select the default one).
 - Created Wiki pages with documentation for the plugin features
 - DQL now supports complex sorting expressions (for example, `sort abs(field) > 10 desc`)
 - Added missing quick fixes for inspections:
   - Dropping DQL commands and functions for unknown & experimental expressions
-  - Renaming the DQL file to `.partial.dql` when an invalid command context is detected (only for `.dql` files)
+  - Renaming the DQL file to `.dqlpart` when an invalid command context is detected (only for `.dql` files)
 - DQL now supports `/* language=X */` comments in strings
 - Adding a Dynatrace Query Console view that allows the user to execute DQL queries without opening a DQL file.
   You can open the console via the `Tools` -> `Services` -> `Dynatrace Query Console` menu or by clicking the `+` button
diff --git a/docs/wiki/DQL-Expression.md b/docs/wiki/DQL-Expression.md
@@ -11,11 +11,13 @@ tenant is configured.
 
 ## Features
 
-The `.dqlexpr` files inherit features from the [Dynatrace Query Language (`.dql`)](./DQL) files. Inspections related to
-the expression context (like assignment support) are disabled for such files.
+The `.dqlexpr` files inherit features from the [Dynatrace Query Language (`.dql`)](./DQL) files.
+Inspections related to the expression context (like validating assignment support) are disabled for such files.
 
-## Example `.dqlexpr` file
+## Usage
 
-```dqlexpr
+### Example `.dqlexpr` file
+
+```DQLExpr
 matchesPhrase(event.provider, \"my-provider-*\") OR matchesPhrase(event.provider, \"*.my.host\")
 ```
diff --git a/docs/wiki/DQL-Part.md b/docs/wiki/DQL-Part.md
@@ -0,0 +1,41 @@
+# Dynatrace Query Language parts
+
+The `DQLPart` language is a DQL query that disables validation for the query context. This allows you to write DQL
+queries in smaller parts without raising errors related to a wrong DQL command usage.
+
+This is especially useful for dynamic DQL generators, where you define a base part of the query and then add more
+commands to it based on some conditions.
+
+## Features
+
+The `.dqlpart` files inherit features from the [Dynatrace Query Language (`.dql`)](./DQL) files.
+You will not be able to execute such files and automatic tenant verification will be disabled for them, as they will
+most likely never be a valid DQL query on their own.
+
+## Usage
+
+### Example `.dqlpart` file
+
+```DQLPart
+| filter event.provider = "my-provider"
+```
+
+### Example dynamic generator
+
+```Java
+public class Example {
+    public static final String BASE_QUERY = /* language=DQL */ """
+            fetch events, bucket: {"my-bucket"}, from: -1h
+            """;
+
+    public String generateQuery(boolean withFilter) {
+        String query = BASE_QUERY;
+        if (withFilter) {
+            query += /* language=DQLPart */ """
+                      | filter event.provider == "my-provider"
+                    """;
+        }
+        return query;
+    }
+}
+```
diff --git a/docs/wiki/DQL.md b/docs/wiki/DQL.md
@@ -247,6 +247,7 @@ the most common parts of statements and include them into other DQL files.
 This most probably will mean that one of those files will not be a valid DQL by itself, as it will not start with
 a data source command like `fetch`.
 
-Renaming your file to `NAME.partial.dql` will silence the errors about the invalid command context and will disable the
-requirement of prepending every command with a pipe (`|`) sign. Additionally, the partial file will not execute the
-background DQL verification on your tenant, as it would always fail.
+You can store smaller parts of DQL queries in dedicated sublanguages:
+
+- [Expressions DQL](./DQL-Expression.md) - specify only expressions without the DQL command context
+- [DQL Part](./DQL-Part.md) - specify DQL command usages without the need to follow the full DQL syntax rules
diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md
@@ -30,8 +30,9 @@ subpages:
 
 - [Dynatrace Query Language (DQL)](./DQL)
 - [Dynatrace Pattern Language (DPL)](./DPL)
-- [Expressions DQL](./DQL_Expression.md) - smaller subset of DQL files, allowing to specify only expressions
+- [Expressions DQL](./DQL-Expression.md) - smaller subset of DQL files, allowing to specify only expressions
   without the DQL command context
+- [DQL Part](./DQL-Part.md) - smaller parts of the DQL queries, useful for dynamic DQL generators
 
 ## Frequently Asked Questions (FAQ)
 
diff --git a/src/main/java/pl/thedeem/intellij/dql/DQLUtil.java b/src/main/java/pl/thedeem/intellij/dql/DQLUtil.java
@@ -20,6 +20,7 @@
 import pl.thedeem.intellij.dql.psi.DQLParenthesisedExpression;
 import pl.thedeem.intellij.dql.psi.DQLVariableExpression;
 import pl.thedeem.intellij.dql.settings.DQLSettings;
+import pl.thedeem.intellij.dqlpart.DQLPartFileType;
 
 import java.time.Instant;
 import java.time.ZoneId;
@@ -59,9 +60,8 @@ public class DQLUtil {
     private final static String PARTIAL_DQL_NAME = ".partial.";
     private final static String CREDENTIALS_PREFIX = "pl.thedeem.intellij.dql/";
 
-    public static boolean isPartialFile(final PsiFile file) {
-        String name = file.getName();
-        return name.contains(PARTIAL_DQL_NAME);
+    public static boolean isPartialFile(@NotNull PsiFile file) {
+        return DQLPartFileType.INSTANCE.equals(file.getFileType()) || file.getName().contains(PARTIAL_DQL_NAME);
     }
 
     public static List<DQLFieldExpression> findFieldsInFile(PsiFile file, String key) {
diff --git a/src/main/java/pl/thedeem/intellij/dql/actions/ExecuteDQLQueryAction.java b/src/main/java/pl/thedeem/intellij/dql/actions/ExecuteDQLQueryAction.java
@@ -9,6 +9,7 @@
 import pl.thedeem.intellij.common.services.ProjectServicesManager;
 import pl.thedeem.intellij.dql.DQLBundle;
 import pl.thedeem.intellij.dql.DQLFileType;
+import pl.thedeem.intellij.dql.DQLUtil;
 import pl.thedeem.intellij.dql.DynatraceQueryLanguage;
 import pl.thedeem.intellij.dql.definition.model.QueryConfiguration;
 import pl.thedeem.intellij.dql.exec.DQLExecutionService;
@@ -93,6 +94,9 @@ protected boolean isNotRelatedToDQL(@NotNull AnActionEvent e) {
         if (PsiTreeUtil.getChildrenOfType(file, DQLQuery.class) == null) {
             return true;
         }
+        if (DQLUtil.isPartialFile(file)) {
+            return true;
+        }
         Language[] langs = e.getData(LangDataKeys.CONTEXT_LANGUAGES);
         return langs == null || !List.of(langs).contains(DynatraceQueryLanguage.INSTANCE);
     }
diff --git a/src/main/java/pl/thedeem/intellij/dql/inspections/commands/InvalidCommandContextInspection.java b/src/main/java/pl/thedeem/intellij/dql/inspections/commands/InvalidCommandContextInspection.java
@@ -4,6 +4,7 @@
 import com.intellij.codeInspection.LocalQuickFix;
 import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.lang.injection.InjectedLanguageManager;
+import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
 import org.jetbrains.annotations.NotNull;
@@ -76,15 +77,12 @@ public void visitCommand(@NotNull DQLCommand command) {
     }
 
     private static @NotNull String proposePartialName(@NotNull String name) {
-        if (name.contains(".partial.")) {
+        if (StringUtil.endsWithIgnoreCase(name, ".dqlpart")) {
             return name;
         }
-        int dot = name.lastIndexOf('.');
-        if (dot <= 0) {
-            return name + ".partial.dql";
+        if (StringUtil.endsWithIgnoreCase(name, ".dql")) {
+            return name + "part";
         }
-        String base = name.substring(0, dot);
-        String ext = name.substring(dot);
-        return base + ".partial." + ext.substring(1);
+        return name + ".dqlpart";
     }
 }
diff --git a/src/main/java/pl/thedeem/intellij/dql/inspections/fixes/RenameFileQuickFix.java b/src/main/java/pl/thedeem/intellij/dql/inspections/fixes/RenameFileQuickFix.java
@@ -1,5 +1,6 @@
 package pl.thedeem.intellij.dql.inspections.fixes;
 
+import com.intellij.codeInsight.intention.preview.IntentionPreviewInfo;
 import com.intellij.codeInspection.LocalQuickFix;
 import com.intellij.codeInspection.ProblemDescriptor;
 import com.intellij.openapi.project.Project;
@@ -16,6 +17,11 @@ public class RenameFileQuickFix implements LocalQuickFix {
     public RenameFileQuickFix(@NotNull String proposedName) {
         this.proposedName = proposedName;
     }
+    
+    @Override
+    public @NotNull IntentionPreviewInfo generatePreview(@NotNull Project project, @NotNull ProblemDescriptor previewDescriptor) {
+        return IntentionPreviewInfo.EMPTY;
+    }
 
     @Override
     public @NotNull String getFamilyName() {
diff --git a/src/main/java/pl/thedeem/intellij/dql/inspections/fixes/ReplaceFetchWithMetricsQuickFix.java b/src/main/java/pl/thedeem/intellij/dql/inspections/fixes/ReplaceFetchWithMetricsQuickFix.java
@@ -7,11 +7,11 @@
 import org.jetbrains.annotations.Nullable;
 import pl.thedeem.intellij.common.quickFixes.AbstractReplaceElementQuickFix;
 import pl.thedeem.intellij.dql.DQLBundle;
-import pl.thedeem.intellij.dql.services.definition.DQLDefinitionService;
 import pl.thedeem.intellij.dql.definition.model.Command;
 import pl.thedeem.intellij.dql.definition.model.MappedParameter;
 import pl.thedeem.intellij.dql.definition.model.Parameter;
 import pl.thedeem.intellij.dql.psi.DQLCommand;
+import pl.thedeem.intellij.dql.services.definition.DQLDefinitionService;
 
 import java.util.List;
 import java.util.Set;
@@ -43,7 +43,7 @@ public class ReplaceFetchWithMetricsQuickFix extends AbstractReplaceElementQuick
     @NotNull
     @Override
     public String getName() {
-        return DQLBundle.message("inspection.variable.metricSeriesMigration.issueDetected.fix");
+        return DQLBundle.message("inspection.metricSeriesMigration.issueDetected.fix");
     }
 
     @Override
diff --git a/src/main/java/pl/thedeem/intellij/dql/inspections/migrations/MetricSeriesMigrationInspection.java b/src/main/java/pl/thedeem/intellij/dql/inspections/migrations/MetricSeriesMigrationInspection.java
@@ -33,7 +33,7 @@ public void visitCommand(@NotNull DQLCommand command) {
                         if ("metric.series".equalsIgnoreCase(paramValue)) {
                             holder.registerProblem(
                                     command.getCommandKeyword(),
-                                    DQLBundle.message("inspection.variable.metricSeriesMigration.issueDetected"),
+                                    DQLBundle.message("inspection.metricSeriesMigration.issueDetected"),
                                     new ReplaceFetchWithMetricsQuickFix()
                             );
                         }
diff --git a/src/main/java/pl/thedeem/intellij/dql/inspections/migrations/PartialFileMigrationInspection.java b/src/main/java/pl/thedeem/intellij/dql/inspections/migrations/PartialFileMigrationInspection.java
@@ -0,0 +1,33 @@
+package pl.thedeem.intellij.dql.inspections.migrations;
+
+import com.intellij.codeInspection.LocalInspectionTool;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.psi.PsiElementVisitor;
+import org.jetbrains.annotations.NotNull;
+import pl.thedeem.intellij.dql.DQLBundle;
+import pl.thedeem.intellij.dql.inspections.fixes.RenameFileQuickFix;
+import pl.thedeem.intellij.dql.psi.DQLQuery;
+import pl.thedeem.intellij.dql.psi.DQLVisitor;
+
+public class PartialFileMigrationInspection extends LocalInspectionTool {
+    @Override
+    public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
+        return new DQLVisitor() {
+
+            @Override
+            public void visitQuery(@NotNull DQLQuery query) {
+                super.visitQuery(query);
+
+                String fileName = query.getContainingFile().getName();
+                if (StringUtil.endsWithIgnoreCase(fileName, ".partial.dql")) {
+                    holder.registerProblem(
+                            query,
+                            DQLBundle.message("inspection.deprecatedPartialFile.issueDetected"),
+                            new RenameFileQuickFix(fileName.replaceFirst("(?i)\\.partial\\.dql$", ".dqlpart"))
+                    );
+                }
+            }
+        };
+    }
+}
diff --git a/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartFile.java b/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartFile.java
@@ -0,0 +1,22 @@
+package pl.thedeem.intellij.dqlpart;
+
+import com.intellij.extapi.psi.PsiFileBase;
+import com.intellij.openapi.fileTypes.FileType;
+import com.intellij.psi.FileViewProvider;
+import org.jetbrains.annotations.NotNull;
+
+public class DQLPartFile extends PsiFileBase {
+    public DQLPartFile(@NotNull FileViewProvider viewProvider) {
+        super(viewProvider, DQLPartLanguage.INSTANCE);
+    }
+
+    @Override
+    public @NotNull FileType getFileType() {
+        return DQLPartFileType.INSTANCE;
+    }
+
+    @Override
+    public String toString() {
+        return "DQL Part File";
+    }
+}
diff --git a/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartFileType.java b/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartFileType.java
@@ -0,0 +1,38 @@
+package pl.thedeem.intellij.dqlpart;
+
+import com.intellij.openapi.fileTypes.LanguageFileType;
+import org.jetbrains.annotations.NotNull;
+import pl.thedeem.intellij.common.Icons;
+
+import javax.swing.*;
+
+public class DQLPartFileType extends LanguageFileType {
+    public static final DQLPartFileType INSTANCE = new DQLPartFileType();
+
+    public static final String DQL_PART_FILE_EXTENSION = "dqlpart";
+    public static final String DQL_PART_FILE_DESCRIPTION = "Dynatrace Query Language part file";
+
+    private DQLPartFileType() {
+        super(DQLPartLanguage.INSTANCE);
+    }
+
+    @Override
+    public @NotNull String getName() {
+        return DQLPartLanguage.DQL_PART_ID;
+    }
+
+    @Override
+    public @NotNull String getDescription() {
+        return DQL_PART_FILE_DESCRIPTION;
+    }
+
+    @Override
+    public @NotNull String getDefaultExtension() {
+        return DQL_PART_FILE_EXTENSION;
+    }
+
+    @Override
+    public Icon getIcon() {
+        return Icons.DYNATRACE_LOGO;
+    }
+}
diff --git a/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartLanguage.java b/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartLanguage.java
@@ -0,0 +1,13 @@
+package pl.thedeem.intellij.dqlpart;
+
+import com.intellij.lang.Language;
+
+public class DQLPartLanguage extends Language {
+    public static final DQLPartLanguage INSTANCE = new DQLPartLanguage();
+
+    public static final String DQL_PART_ID = "DQLPart";
+
+    private DQLPartLanguage() {
+        super(DQL_PART_ID);
+    }
+}
diff --git a/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartParserDefinition.java b/src/main/java/pl/thedeem/intellij/dqlpart/DQLPartParserDefinition.java
@@ -0,0 +1,56 @@
+package pl.thedeem.intellij.dqlpart;
+
+import com.intellij.lang.ASTNode;
+import com.intellij.lang.ParserDefinition;
+import com.intellij.lang.PsiParser;
+import com.intellij.lexer.Lexer;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.FileViewProvider;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.tree.IFileElementType;
+import com.intellij.psi.tree.TokenSet;
+import org.jetbrains.annotations.NotNull;
+import pl.thedeem.intellij.dql.DQLLexerAdapter;
+import pl.thedeem.intellij.dql.DQLParser;
+import pl.thedeem.intellij.dql.psi.DQLTokenSets;
+import pl.thedeem.intellij.dql.psi.DQLTypes;
+
+public class DQLPartParserDefinition implements ParserDefinition {
+    public static final IFileElementType FILE = new IFileElementType(DQLPartLanguage.INSTANCE);
+
+    @Override
+    public @NotNull Lexer createLexer(Project project) {
+        return new DQLLexerAdapter();
+    }
+
+    @Override
+    public @NotNull TokenSet getCommentTokens() {
+        return DQLTokenSets.COMMENTS;
+    }
+
+    @Override
+    public @NotNull TokenSet getStringLiteralElements() {
+        return DQLTokenSets.STRING_LITERALS;
+    }
+
+    @Override
+    public @NotNull PsiParser createParser(Project project) {
+        return new DQLParser();
+    }
+
+    @Override
+    public @NotNull IFileElementType getFileNodeType() {
+        return FILE;
+    }
+
+    @Override
+    public @NotNull PsiFile createFile(@NotNull FileViewProvider viewProvider) {
+        return new DQLPartFile(viewProvider);
+    }
+
+    @Override
+    public @NotNull PsiElement createElement(ASTNode node) {
+        return DQLTypes.Factory.createElement(node);
+    }
+}
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
diff --git a/src/main/resources/inspectionDescriptions/DQLPartialFileMigration.html b/src/main/resources/inspectionDescriptions/DQLPartialFileMigration.html
diff --git a/src/main/resources/messages/DQLBundle.properties b/src/main/resources/messages/DQLBundle.properties

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`import com.intellij.codeInspection.LocalQuickFix;`
`5`	`5`	`import com.intellij.codeInspection.ProblemsHolder;`
`6`	`6`	`import com.intellij.lang.injection.InjectedLanguageManager;`
	`7`	`+import com.intellij.openapi.util.text.StringUtil;`
`7`	`8`	`import com.intellij.psi.PsiElement;`
`8`	`9`	`import com.intellij.psi.PsiElementVisitor;`
`9`	`10`	`import org.jetbrains.annotations.NotNull;`
`@@ -76,15 +77,12 @@ public void visitCommand(@NotNull DQLCommand command) {`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`private static @NotNull String proposePartialName(@NotNull String name) {`
`79`		`- if (name.contains(".partial.")) {`
	`80`	`+ if (StringUtil.endsWithIgnoreCase(name, ".dqlpart")) {`
`80`	`81`	`return name;`
`81`	`82`	`}`
`82`		`- int dot = name.lastIndexOf('.');`
`83`		`- if (dot <= 0) {`
`84`		`- return name + ".partial.dql";`
	`83`	`+ if (StringUtil.endsWithIgnoreCase(name, ".dql")) {`
	`84`	`+ return name + "part";`
`85`	`85`	`}`
`86`		`- String base = name.substring(0, dot);`
`87`		`- String ext = name.substring(dot);`
`88`		`- return base + ".partial." + ext.substring(1);`
	`86`	`+ return name + ".dqlpart";`
`89`	`87`	`}`
`90`	`88`	`}`