Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

3.2 KB
Raw Blame
import { LemonCollapse } from '@posthog/lemon-ui'

import { LemonButton } from 'lib/lemon-ui/LemonButton'
import { copyToClipboard } from 'lib/utils/copyToClipboard'

import { DatabaseSchemaField } from '~/queries/schema/schema-general'

export type DataWarehouseColumnsHintProps = {
    schemaColumns: DatabaseSchemaField[]
    tableName?: string
    // Destinations resolve a person and event from the synced row, so `{person}`/`{event}` are valid
    // globals there. Workflow triggers are row-scoped (no person/event), so they leave this false.
    personAvailable?: boolean
}

/**
 * Shows the columns of the selected warehouse table and how to reference them in templates.
 * Warehouse rows are delivered under `event.properties`, but `record` is the friendlier alias users
 * write, so we surface that form with click-to-copy. A hog field has the alias rewritten on save; a
 * liquid field resolves it at render. The engine is chosen per field on each downstream step, which
 * this panel cannot see, so the text names both forms rather than guessing one.
 */
export function DataWarehouseColumnsHint({
    schemaColumns,
    tableName,
    personAvailable = false,
}: DataWarehouseColumnsHintProps): JSX.Element | null {
    if (!schemaColumns.length) {
        return null
    }

    return (
        <LemonCollapse
            size="small"
            panels={[
                {
                    key: 'columns',
                    header: tableName ? `Reference columns from ${tableName}` : 'Reference table columns',
                    content: (
                        <div className="flex flex-col gap-2">
                            <p className="mb-0 text-xs text-secondary">
                                Use <code>{'{record.<column>}'}</code> in Hog fields or{' '}
                                <code>{'{{ record.<column> }}'}</code> in Liquid fields to insert a value from the
                                synced row.{' '}
                                {personAvailable ? (
                                    <>
                                        <code>person</code> and <code>event</code> work the same way.{' '}
                                    </>
                                ) : null}
                                Click a column to copy the Hog form.
                            </p>
                            <div className="flex flex-wrap gap-1">
                                {schemaColumns.map((column) => (
                                    <LemonButton
                                        key={column.name}
                                        size="xsmall"
                                        type="secondary"
                                        tooltip={`Copy {record.${column.name}}`}
                                        onClick={() =>
                                            void copyToClipboard(`{record.${column.name}}`, 'column reference')
                                        }
                                    >
                                        {column.name}
                                    </LemonButton>
                                ))}
                            </div>
                        </div>
                    ),
                },
            ]}
        />
    )
}