Customer DB: Materialize Free Customer Companies

Pull companies from the shared company database with a SQL query and save them into your workspace’s companies table.

Tool ID: materialize_free_customer_companies

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'materialize_free_customer_companies',
  {
    "sql": "SELECT * FROM companies LIMIT 10"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute materialize_free_customer_companies --input '{
  "sql": "SELECT * FROM companies LIMIT 10"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "schema": "example",
  "processed": 123,
  "inserted": 123,
  "updated": 123,
  "sql": "SELECT * FROM companies LIMIT 10",
  "limit": 123
}

Use deepline describe materialize_free_customer_companies --json for the latest machine-readable contract.

Input reference

Run a single read-only SQL statement against the shared free company corpus and upsert the returned company rows into enrichments.companies in the tenant customer DB. Only row-shaped company results are allowed.

Name	Type	Required	Default	Details
`payload.sql`	`string`	Yes	—	Single read-only SQL statement to execute against the shared free company corpus before upserting rows into enrichments.companies. SQL must include LIMIT, LIMIT must be <= 100000, and the result columns must be limited to: domain, company_name, industry, location, linkedin_url, employee_count, year_founded. Aggregate-only shapes like count(*) are rejected. Minimum length: 1.

Output reference

Name	Type	Required	Default	Details
`result.schema`	`string`	Yes	—	—
`result.processed`	`integer`	Yes	—	—
`result.inserted`	`integer`	Yes	—	—
`result.updated`	`integer`	Yes	—	—
`result.sql`	`string`	Yes	—	—
`result.limit`	`integer`	Yes	—	—

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation