Skip to content

Feature: Markdown table output format (--markdown) #619

@dlevy-msft-sql

Description

@dlevy-msft-sql

Summary

Add a --markdown flag to output query results as Markdown tables.

Use Case

  • Copy/paste results directly into GitHub issues, PRs, or documentation
  • Generate documentation from database queries
  • Integration with documentation pipelines

Proposed Syntax

sqlcmd -S server -Q "SELECT * FROM users" --markdown

Example Output

| id | name | email |
|----|------|-------|
| 1 | Alice | alice@example.com |
| 2 | Bob | bob@example.com |

Implementation Notes

  • Could leverage existing formatter infrastructure in pkg/sqlcmd/formatter.go
  • Similar approach to how XML output is handled

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions