question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support column descriptions in metadata.json

See original GitHub issue

Could look something like this:

{
    "title": "Five Thirty Eight",
    "license": "CC Attribution 4.0 License",
    "license_url": "https://creativecommons.org/licenses/by/4.0/",
    "source": "fivethirtyeight/data on GitHub",
    "source_url": "https://github.com/fivethirtyeight/data",
    "databases": {
        "fivethirtyeight": {
            "tables": {
                "mueller-polls/mueller-approval-polls": {
                    "description_html": "<p>....</p>",
                    "columns": {
                        "name_of_column": "column_description goes here"
}

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:4
  • Comments:18 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
simonwcommented, Aug 12, 2021

I’m going with "columns": {"name-of-column": "description-of-column"}.

If I decide to make "col" and "nocol" available in metadata I’ll use those as the keys in the metadata, for consistency with the existing query string parameters.

I’m OK with having both "columns": ... and "col": ... keys in the metadata, even though they could be a tiny bit confusing without the documentation.

1reaction
simonwcommented, Dec 2, 2020

My idea is that if you installed my proposed plugin you wouldn’t need metadata.json at all - your metadata would instead live in a table in the connected SQLite database files - either one table per database (so the metadata can live in the same place as the data) or maybe also in a dedicated separate database file, for if you want to add metadata to an otherwise read-only database.

The plugin would then provide a UI for editing that metadata - maybe by configuring some writable canned queries or maybe something more custom than that. Or you could edit the metadata by manually editing the SQLite database file (or loading data into it using a tool like yaml-to-sqlite).

Read more comments on GitHub >

github_iconTop Results From Across the Web

Metadata JSON Files: /Documentation - LabKey Support
A metadata file written in JSON is used to configure the fields and categories for document abstraction. The file configures the field categories...
Read more >
Metadata - Datasette documentation
Column descriptions #. You can include descriptions for your columns by adding a "columns": {"name-of-column": ...
Read more >
How to include column metadata in JSON for an empty ...
On deserialization, this metadata is used to reconstruct the table with the correct column types and names, even if there are no other...
Read more >
The metadata file (model.json) for Common Data Model
The metadata file (or model.json) in a Common Data Model folder describes the data in the folder, metadata and location, as well as...
Read more >
How to pass metadata(column info) & data separately to grid ...
I would like to pass column-info & data separately to datasource in json form. having column header label in each row is very...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found