Repository navigation
feat(export): export a data dictionary of tables and columns as Markdown or HTML - #3735
Merged
Merged
Conversation
…ads in the dictionary
…or the dictionary
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DataDictionaryExportPlugin), in the Export sheet's tree and saved selections. File > Export > Export Data Dictionary… opens the sheet on it.columnsAreSampled), nor DynamoDB and SurrealDB, whose column lists sample items.ExportFormatPlugin.readsRows(optionValues:kind:),PluginExportDataSource.fetchIndexesandfetchObjectComment,PluginDatabaseDriver.fetchObjectComment(table:schema:).fetchObjectCommentdefaults to the table metadata's comment. DuckDB answers it from the catalog, since its metadata probes up to 100,001 rows. The Structure tab and Edit Comment read the comment through it too.ExportServicecounts rows only for objects whose rows the format reads. A SQL export with Structure only no longer runsCOUNT(*)over every table first. An export that reads no rows shows progress in objects.Test plan
DataDictionaryExportTests: catalog-only reads, Markdown and HTML output, omitted columns, escaping, anchors, composite and cross-schema keys, read failures, prefix indexes, cancellation.ExportServiceRowCountTests: noCOUNT(*)for a structure-only export, only Data tables counted, views keep row progress.ExportDataSourceAdapterCatalogTests,ExportFormatCatalogTests,SQLExportReadsRowsTests.ExportUITests.testExportingADataDictionaryWritesMarkdown: File menu to a Markdown file on the fixture database.verify.sh abi: additive, kit 40, minimum 19.Fixes #3624