Skip to content

Show column name for events and entities - #1776

Open
Miranda Wilson (mscwilson) wants to merge 7 commits into
mainfrom
column-names-for-entities
Open

Show column name for events and entities#1776
Miranda Wilson (mscwilson) wants to merge 7 commits into
mainfrom
column-names-for-entities

Conversation

@mscwilson

Copy link
Copy Markdown
Contributor

Updates the SchemaProperties component to show the expected column name for that schema. Makes it easier for analysts to find where data has come from.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 12, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation 03b8e11 Commit Preview URL

Branch Preview URL
May 13 2026, 08:45 AM

@claude

claude Bot commented May 12, 2026

Copy link
Copy Markdown

Writing review

This PR is mostly code, but it does introduce a small amount of user-facing prose in src/components/SchemaProperties/index.js. A few suggestions to align it with the style guide:

"In most warehouses:" reads as a sentence fragment

The first paragraph is rendered inside a <p> tag but is structured as a label fragment followed by code:

In most warehouses: unstruct_event_<vendor>_<name>_<major>

The style guide favors complete sentences in prose. Suggest rephrasing to a full sentence, e.g.:

In most warehouses, the column name is unstruct_event_<vendor>_<name>_<major>.

(And likewise for the entity variant with contexts_….)

Ambiguous link sentence

See the querying overview for Redshift and older BigQuery Loader versions.

This can be parsed two ways. The intended meaning is "for [Redshift, and older versions of the BigQuery Loader], see the querying overview" — but it can be misread as "the querying overview for [Redshift and older BigQuery Loader versions]" (i.e. an overview specific to those).

It's also not explicit why the reader would click through. Consider leading with the exception:

Redshift and older versions of the BigQuery Loader use different column names — see the querying overview.

That also makes the link text's destination concrete, which is a small win for accessibility and scannability.

Two near-identical blocks

The event branch (unstruct_event_…) and entity branch (contexts_…) duplicate the wording around the code. If the copy is ever updated, the two paragraphs will drift. Worth extracting a tiny helper component (or at minimum the explanatory sentence as a constant) so the prose lives in one place.

Other nits

  • "Warehouse column name" heading — sentence case, good ✅.
  • <code> and <a> usage looks fine for a React component (the /index.md link convention in CLAUDE.md is for Markdown link validation, not runtime hrefs).
  • In docs/reusable/event-query/_index.md, the previously-default BigQuery tab no longer has a default attribute and no other tab takes it. The first tab (Redshift) will become the de-facto default; if that's intentional, consider marking it default explicitly for clarity. If the previous default was deliberate, you may want to restore it. (Not a writing issue, but adjacent.)
  • Sidebar/tab labels: dropping "& Postgres" from the Redshift tab is fine since Postgres isn't mentioned in /docs/destinations/warehouses-lakes/querying-data/index.md anymore, but worth a quick grep across the repo to make sure no other reusable still routes Postgres readers to that tab label.

Nothing blocking — the prose changes are small and the existing tone matches the rest of the docs.

Comment thread docs/reusable/event-query/_index.md Outdated
</TabItem>

<TabItem value="redshift" label="Redshift & Postgres">
<TabItem value="synapse" label="Synapse Analytics">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s remove Synapse altogether

props.schema.properties && Object.keys(props.schema.properties).length > 0
const warehouseNote = (
<p>
Redshift and older versions of the BigQuery Loader use different names —

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snowflake also uses different names, we turn schema fields into camelCase

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants