> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Databricks

> Generate a deployable pipeline that loads GTM events into Octave from Databricks

Two extract strategies: a watermark query for the initial backfill, and Delta change data feed for everything after it. Unlike the other sources, the runtime can stay inside the workspace.

## What you need

* `SELECT` on the tables and a SQL warehouse or serverless compute
* An Octave workspace API key, from **Settings → Integrations**
* Nothing outside Databricks — the job runs in the workspace

## Where this runs

A Databricks Job is the natural runtime here. It schedules itself, holds secrets, and already has warehouse access, so there is no external function to deploy and no network path to arrange.

|                      |                                                        |
| -------------------- | ------------------------------------------------------ |
| **Runtime**          | Databricks Job, Python task on serverless compute      |
| **Trigger**          | The job's own schedule, hourly                         |
| **Secrets**          | Databricks secret scope                                |
| **Watermark**        | A Delta table holding the last processed table version |
| **Incremental read** | `table_changes()` — Delta change data feed             |
| **Initial backfill** | Same job, `modified_at` filter, before CDF is enabled  |

## The prompt

Copy this into Claude Code, Cursor or any coding agent. It carries the whole flow —
reading your warehouse, mapping the columns, posting to Octave, and deploying the result.

Fill in section 1 with your real schema and a few sample rows (`DESCRIBE TABLE EXTENDED analytics.gtm.opportunities` — it also tells you whether change data feed is already on). The more of
your actual data it can see, the less it has to guess.

```text theme={null}
I want to load GTM history from Databricks into Octave, and keep it current after that.
Start by working out the column mapping. Do not write any code until the mapping is
agreed.

## 1. Here is my data

Warehouse: Databricks, catalog `analytics`, schema `gtm`
Tables and what they hold:
  opportunities  -> deals
  email_log      -> outbound sends and replies
Incremental strategy: Delta change data feed, watermark is a table version

<PASTE YOUR SCHEMA AND 3-5 SAMPLE ROWS HERE, ONE BLOCK PER TABLE>

## 2. Where this needs to run

Runtime: a Databricks Job running a Python task on serverless compute
Trigger: the job's own schedule, hourly
Secrets: Octave API key in a Databricks secret scope
Watermark: a Delta table holding the last processed table version
Constraint: keep this inside the workspace. Only propose an external runtime if
there is a concrete reason the job cannot reach app.octavehq.com, and say what it
is. Change data feed is not retroactive, so the initial backfill needs a
modified_at filter and the incremental run needs table_changes().

## 3. Here is what Octave needs

Four event types. Every event carries a "type" discriminator.

CRM event - a deal:
{
  "type": "crm",
  "eventTimestamp": "2024-02-03T16:00:00.000Z",
  "eventType": "opportunity_created",
  "opportunityId": "opp_12345",
  "opportunityName": "Acme Corp - Enterprise Plan",
  "amount": "50000.00",
  "currency": "USD",
  "stage": "Qualification",
  "stageCategory": "open",
  "accountName": "Acme Corp",
  "crmAccountId": "acct_67890",
  "crmAccountDomain": "acme.com",
  "contactEmail": "john@acme.com",
  "contactEmails": ["john@acme.com", "priya@acme.com"],
  "ownerEmail": "sarah@company.com",
  "closeDate": "2024-03-31T00:00:00.000Z",
  "crmLastModifiedAt": "2024-02-03T16:00:00.000Z",
  "eventId": "<stable id derived from my row>"
}

Email event:
{
  "type": "email",
  "eventTimestamp": "2024-02-03T10:30:00.000Z",
  "eventType": "sent",
  "subject": "Follow up on our conversation",
  "body": { "text": "Hi John, just wanted to follow up..." },
  "from": { "email": "sarah@company.com", "name": "Sarah Johnson" },
  "to": [{ "email": "john@acme.com", "name": "John Smith" }],
  "crmOpportunityId": "opp_12345",
  "eventId": "<stable id derived from my row>"
}

Call event:
{
  "type": "call",
  "eventTimestamp": "2024-02-03T14:00:00.000Z",
  "eventType": "transcript",
  "title": "Discovery Call - Acme Corp",
  "transcript": [
    { "speaker": { "name": "Sarah Johnson", "email": "sarah@company.com", "role": "internal" },
      "text": "Thanks for making the time. What pushed you to look at this now?" },
    { "speaker": { "name": "John Smith", "email": "john@acme.com", "role": "external" },
      "text": "Our current process breaks down past about fifty reps." }
  ],
  "participants": [
    { "name": "Sarah Johnson", "email": "sarah@company.com", "role": "internal" },
    { "name": "John Smith", "email": "john@acme.com", "role": "external" }
  ],
  "crmOpportunityId": "opp_12345",
  "eventId": "<stable id derived from my row>"
}

Social event:
{
  "type": "social",
  "eventTimestamp": "2024-02-03T11:00:00.000Z",
  "eventType": "message_sent",
  "body": { "text": "Thanks for connecting, John." },
  "from": { "email": "sarah@company.com", "name": "Sarah Johnson" },
  "to": [{ "email": "john@acme.com", "name": "John Smith" }],
  "eventId": "<stable id derived from my row>"
}

Required fields - everything else is optional:
  email:  type, eventTimestamp, eventType, subject, body, from, to
  call:   type, eventTimestamp, eventType, title, transcript, participants
  crm:    type, eventTimestamp, eventType, opportunityId, opportunityName
  social: type, eventTimestamp, eventType, body, from, to

eventType must be one of:
  email:  sent | reply | opened | clicked | bounced | unsubscribed
  call:   transcript | scheduled | completed | missed
  crm:    opportunity_created | deal_won | deal_lost | meeting_booked
  social: connection_sent | connection_accepted | message_sent | message_received

Only email sent/reply and call transcript are analysed. All CRM and all social
types are analysed. Other email and call types are stored but produce nothing.

## 4. Map my columns onto those structures

Apply these rules:

- eventTimestamp accepts ISO 8601, epoch milliseconds (>= 1e12) or epoch seconds.
  Pass my column straight through if it is already one of those. It must resolve
  within 50 years past and 5 years future - flag sentinel dates (9999-12-31,
  1900-01-01, epoch zero) as rows to drop rather than rows to send.
- Combine separate name and email columns into { "email": ..., "name": ... }.
  Only email is required. Split comma-separated recipient strings into an array.
- Send "amount" as a STRING, not a number, so my decimal precision survives.
- Derive CRM "eventType" from my stage or status column, and set "stageCategory"
  to open, won or lost explicitly rather than letting Octave infer it.
- ONE SOURCE ROW MAY BE SEVERAL EVENTS. A deal row with both a created date and a
  closed date is an opportunity_created event AND a deal_won or deal_lost event,
  each with its own eventTimestamp and its own eventId. Do not collapse them.
- Always send "crmLastModifiedAt" on CRM events. Without it an updated deal can
  hash identical to the previous push and be dropped as a duplicate.
- Prefer a structured transcript array over a flat string. Decide speaker role by
  email domain: my company's domain is "internal", everything else is "external".
- Set "eventId" (<= 255 chars) from the row's stable primary key. Where one row
  expands into several events, suffix it per event so each one stays distinct.
- Populate "contactEmails" with every contact on the deal, not just the primary -
  it is the biggest single lever on how much activity attaches to the opportunity.
  Same for "crmAccountId", "crmAccountDomain" and "lossReason" where I have them.
- On email, call and social rows that already reference a deal, set
  "crmOpportunityId" - it skips Octave's participant-matching inference.
- Omit keys whose source value is NULL. Do not send explicit nulls.

Show me the proposed mapping as a table - my column, Octave field, transformation.
List every Octave field you could not source, and every column of mine you ignored.
Wait for me to confirm the mapping before you write any code.

## 5. Then build and deploy it

Target: POST https://app.octavehq.com/api/v2/event/import
Header: api_key: <my Octave workspace key>
Body:   { "events": [ ... ] }     # max 1000 per request, mixed types allowed

Response: { "jobs": [ { "eventType", "jobOId", "accepted", "preSkipped",
                        "duplicatesInBatch" } ],
            "totalAccepted", "totalPreSkipped" }

One job is created per event type present in the request. Poll each one:
GET https://app.octavehq.com/api/v2/event/import/status?jobOId=<jobOId>
every 5-10 seconds until status is COMPLETED (or FAILED / CANCELLED).
counts.ingested is the authoritative success count. counts.skipped covers
duplicates and non-processable event types and is not an error - alert on
counts.failed instead.

A 400 means NOTHING in that request was imported; the message lists the offending
zero-based indices. Retry 429 and 5xx with exponential backoff, and keep only a
few requests in flight.

Build this for the runtime I named in section 2, and give me:
- the handler code,
- infrastructure-as-code to deploy it - tell me which format you are using and why,
- the watermark held in a managed store rather than on local disk, so a cold start
  resumes where the previous run finished,
- credentials read from the platform's secret manager, never baked into the code,
- structured logs carrying ingested / skipped / failed per batch, and an alert
  condition worth paging on,
- a note on what happens if a run hits the runtime's execution limit, and what to
  change if my history is too large to backfill in a single invocation.

Keep the column mapping in one dict at the top of the handler so I can correct it
without touching the transport or the deployment code.
```

<Tip>
  The instruction to show the mapping as a table and wait for confirmation is the part worth
  keeping. Without it an agent guesses at your column names and buries the guess inside a
  handler, where a wrong `eventType` looks exactly like a right one until the data is in.
</Tip>

## Hints worth adding

These are the things that go wrong with Databricks specifically. Paste whichever apply into
section 1 of the prompt — an agent cannot infer them from a schema.

**Change data feed is not retroactive.** `table_changes()` returns nothing for history
that predates enabling it. The backfill and the incremental run genuinely need two different
queries — say so, or you get one that silently misses everything before the switch.

**CDF emits every update twice.** `update_preimage` and `update_postimage` both come back.
Ask for a filter to `insert` and `update_postimage`, or each change maps to two events.

**`DECIMAL` loses precision through JSON.** Ask for a cast to string and `amount` sent as a
string.