DQLEditor

The DQLEditor is specifically designed for editing DQL queries. It further offers syntax highlighting and autocomplete functionality specific to the Dynatrace Query Language. Once the editor is focused via the keyboard, the user must press "Enter" to start editing and "Escape" to quit editing and return to the keyboard navigation flow.

OverviewPropertiesUsage

When to use

• Users need to write and edit queries using Dynatrace Query Language (DQL).
• In developer tools, debugging interfaces, or advanced user workflows. DQLEditor is designed for users working directly with DQL for precise control over data retrieval.
• If query reusability and sharing are important. DQLEditor lets users craft, save, and share complex queries that can be reused across different Dynatrace applications and contexts.

When not to use

• For editing other programming languages or configuration formats than DQL. Use CodeEditor instead.
• For read-only display of short snippets of code (DQL and other languages), use CodeSnippet.
• For predefined filtering tasks. Use FilterField or FilterBar instead.
• For basic text inputs, use TextInput or TextArea.

Content guidelines

Label (recommended)

Add a label that describes the purpose or context for the input. It should be descriptive but short (1-2 words).

• Do: Filter query
• Don't: DQL
• Don't: CodeEditor

Placeholder (required)

Default placeholder: Add DQL

The default placeholder text works for most use cases. Optionally, you can customize the placeholder text for more specificity to your use case.

Use hint for essential information

Don't use the placeholder for information users need to complete the task, as placeholders disappear when users start typing.

Hint (optional)

Use the hint for additional information that helps users add valid code and avoid errors. Provide any error messages with the hint.

• Keep the hint short.
• Only add periods after sentences.