Coral

https://withcoral.com/docs
Admin
Coral is a single SQL interface for querying APIs, files, and other data sources, with support for...
Tokens:25,663
Snippets:434
Trust Score:6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Coral CLI

Source: https://withcoral.com/docs

Install the Coral command-line interface using Homebrew. This is the primary method for getting started with Coral.

```bash
brew install withcoral/tap/coral

```

--------------------------------

### Run the guided Coral source setup flow

Source: https://withcoral.com/docs/reference/cli-reference

Initiates the interactive, guided process for setting up a new Coral source.

```shellscript
coral onboard
```

--------------------------------

### Get Source Information

Source: https://withcoral.com/docs/reference/cli-reference

Show metadata for a specific source, including installation status, origin, version, description, and inputs. Use the `--verbose` flag for more detailed output.

```shellscript
coral source info datadog
coral source info datadog --verbose
```

--------------------------------

### Install Coral via Install Script

Source: https://withcoral.com/docs/getting-started/installation

Execute this script to download and install the Coral CLI.

```shellscript
curl -fsSL https://withcoral.com/install.sh | sh
```

--------------------------------

### Install Coral from Source

Source: https://withcoral.com/docs/getting-started/installation

Build and install the Coral CLI from source using Make. Requires Rust, Node.js/npm, and Make.

```shellscript
make install
coral --help
```

--------------------------------

### Verify Coral Installation on Windows

Source: https://withcoral.com/docs/getting-started/installation

Run these commands to verify that Coral has been installed correctly and is accessible.

```powershell
coral --version
coral source discover
coral onboard
```

--------------------------------

### Install Compiled Windows Binary

Source: https://withcoral.com/docs/getting-started/installation

Copy the compiled Coral CLI binary to the user's local bin directory.

```powershell
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.local\bin"
Copy-Item "target\release\coral.exe" "$env:USERPROFILE\.local\bin\coral.exe"
```

--------------------------------

### Add PATH and Verify Windows Build

Source: https://withcoral.com/docs/getting-started/installation

Add the installation directory to the PATH and verify the build by running Coral commands.

```powershell
[Environment]::SetEnvironmentVariable("Path", "$env:USERPROFILE\.local\bin;$env:Path", "User")
$env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
coral --version
coral source discover
coral onboard
```

--------------------------------

### Example Test Query

Source: https://withcoral.com/docs/reference/source-spec-reference

An example of the `test_queries` field in a source spec, used for read-only SQL checks after the source is validated.

```yaml
test_queries:
  - SELECT * FROM my_source.messages LIMIT 1
```

--------------------------------

### Start the local Coral UI server without opening a browser

Source: https://withcoral.com/docs/reference/cli-reference

Starts the local Coral UI server on the default loopback address and port without automatically launching a web browser.

```shellscript
coral ui --no-open
```

--------------------------------

### Install Coral MCP on Windows with add-mcp

Source: https://withcoral.com/docs/guides/use-coral-over-mcp

Use the add-mcp tool to add the Coral MCP server to your system on Windows PowerShell. The -g flag installs it globally.

```powershell
npx add-mcp -n coral -g "$((Get-Command coral).Source) mcp-stdio"
```

--------------------------------

### Cursor Query Pagination Example

Source: https://withcoral.com/docs/reference/source-spec-reference

Configure cursor-based pagination using a query parameter for the cursor. Specifies default and maximum page sizes, and the query parameter for page size.

```yaml
pagination:
  mode: cursor_query
  cursor_param: after
  response_cursor_path:
    - pagination_meta
    - after
  page_size:
    default: 25
    max: 100
    query_param: page_size
```

--------------------------------

### Link Header Pagination Example

Source: https://withcoral.com/docs/reference/source-spec-reference

Configure pagination using the Link header, common in APIs like GitHub. Sets default and maximum page sizes, and the query parameter for page size.

```yaml
pagination:
  mode: link_header
  page_size:
    default: 30
    max: 100
    query_param: per_page
```

--------------------------------

### Query GitHub Repositories

Source: https://withcoral.com/docs

Execute a SQL query directly using the Coral CLI. This example retrieves repository names and stargazer counts from GitHub.

```bash
coral sql "SELECT name, stargazers_count FROM github.org_repos WHERE org = 'withcoral' ORDER BY stargazers_count DESC"

```

--------------------------------

### Add GitHub Source Interactively

Source: https://withcoral.com/docs

Add a new data source to your Coral workspace. This example shows how to interactively add the GitHub source.

```bash
coral source add --interactive github

```

--------------------------------

### Add GitHub Source Interactively

Source: https://withcoral.com/docs/getting-started/quickstart

Adds the GitHub source to Coral by interactively prompting for required inputs. Use this for a guided setup.

```shellscript
coral source add --interactive github
```

--------------------------------

### Expose the local Coral runtime as an MCP stdio server

Source: https://withcoral.com/docs/reference/cli-reference

Starts an MCP stdio server that exposes the local Coral runtime. This command is typically launched by an MCP-capable client.

```shellscript
coral mcp-stdio
```

--------------------------------

### Cursor Body Pagination Example

Source: https://withcoral.com/docs/reference/source-spec-reference

Configure cursor-based pagination where the cursor is sent in the request body. Includes JSON paths for the cursor in the request and response, and default page size.

```yaml
pagination:
  mode: cursor_body
  cursor_body_path:
    - query
    - cursor
  response_cursor_path:
    - data
    - nextCursor
  page_size:
    default: 50
```

--------------------------------

### Add User PATH for Windows Install

Source: https://withcoral.com/docs/getting-started/installation

Add the local bin directory to your user PATH environment variable and update the current session's PATH.

```powershell
[Environment]::SetEnvironmentVariable("Path", "$env:USERPROFILE\.local\bin;$env:Path", "User")
$env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
```

--------------------------------

### Install Coral MCP on macOS/Linux with add-mcp

Source: https://withcoral.com/docs/guides/use-coral-over-mcp

Use the add-mcp tool to add the Coral MCP server to your system on macOS or Linux. The -g flag installs it globally.

```shellscript
npx add-mcp -n coral -g "$(which coral) mcp-stdio"
```

--------------------------------

### Upgrade Coral using Homebrew

Source: https://withcoral.com/docs/getting-started/installation

Use this command to upgrade your Coral installation if you initially installed it via Homebrew.

```shellscript
brew upgrade withcoral/tap/coral
```

--------------------------------

### Test an installed Coral source

Source: https://withcoral.com/docs/reference/cli-reference

Validates that an installed source can initialize, expose tables, and run optional top-level test queries. Errors if any declared query tests fail.

```shellscript
coral source test github
coral source test local_messages
```

--------------------------------

### Add Coral Skills

Source: https://withcoral.com/docs/getting-started/installation

Install the official Coral agent skills to enhance Coral's capabilities.

```shellscript
npx skills add withcoral/skills
```

--------------------------------

### Discover Bundled Sources

Source: https://withcoral.com/docs/getting-started/quickstart

Lists the bundled data sources available in your Coral installation. This helps you understand what data connectors are pre-integrated.

```shellscript
coral source discover
```

--------------------------------

### Search Issues with GitHub API

Source: https://withcoral.com/docs/guides/write-a-custom-source

Example of using a search function to find issues in a GitHub repository. Search functions are provider-native and called from SQL.

```sql
SELECT id, title, url
FROM github.search_issues(q => 'repo:withcoral/coral source functions')
LIMIT 10
```

--------------------------------

### File Path Partitioning (Positional Segments)

Source: https://withcoral.com/docs/reference/source-spec-reference

Configures positional path segments for JSON and JSONL tables. Partitions are derived from the index of segments in the path. Example path: '2026/05/14/session.jsonl'.

```yaml
source:
  location: file:///Users/james/.codex/sessions/
  glob: "20??/**/*.jsonl"
  partitions:
    - name: year
      type: Int64
      path:
        kind: segment
        index: 0
    - name: month
      type: Int64
      path:
        kind: segment
        index: 1
    - name: day
      type: Int64
      path:
        kind: segment
        index: 2
```

--------------------------------

### Configuring HTTP Rate Limiting for GitHub-style APIs

Source: https://withcoral.com/docs/reference/source-spec-reference

Configure HTTP rate limiting behavior for provider-specific responses. This example shows how to specify additional status codes that indicate rate limiting and the headers used to track remaining requests and reset times, suitable for APIs like GitHub's.

```yaml
rate_limit:
  extra_statuses: [403]
  remaining_header: X-RateLimit-Remaining
  reset_header: X-RateLimit-Reset
```

--------------------------------

### Uninstall Coral using Homebrew

Source: https://withcoral.com/docs/getting-started/installation

Use this command to uninstall Coral if it was installed via Homebrew.

```shellscript
brew uninstall withcoral/tap/coral
```

--------------------------------

### Call HTTP Search Table Function

Source: https://withcoral.com/docs/reference/source-spec-reference

Example of calling the `search_issues` table function using SQL, passing a query string and limiting the results.

```sql
SELECT id, title, html_url
FROM github.search_issues(q => 'repo:withcoral/coral source functions')
LIMIT 10;
```

--------------------------------

### Uninstall Coral installed via Script

Source: https://withcoral.com/docs/getting-started/installation

Remove Coral binary and configuration files if installed using the install script.

```shellscript
rm -f ~/.local/bin/coral
rm -rf ~/.config/coral
```

--------------------------------

### Remove an installed Coral source

Source: https://withcoral.com/docs/reference/cli-reference

Removes a previously installed Coral source from the system.

```shellscript
coral source remove github
```

--------------------------------

### Configure a file-backed table with S3 source

Source: https://withcoral.com/docs/reference/source-spec-reference

Set up a table with an S3 source, specifying the bucket location and authentication details. Supports 'jsonl' format and requires input variables for region and credentials.

```yaml
inputs:
  AWS_REGION:
    kind: variable
    default: us-east-1
  AWS_ACCESS_KEY_ID:
    kind: secret
  AWS_SECRET_ACCESS_KEY:
    kind: secret
tables:
  - name: events
    description: S3 events
    format: jsonl
    source:
      location: s3://example-bucket/events/
      object_store:
        type: s3
        region: "{{input.AWS_REGION}}"
        auth:
          type: access_key
          access_key_id: "{{input.AWS_ACCESS_KEY_ID}}"
          secret_access_key: "{{input.AWS_SECRET_ACCESS_KEY}}"
```

--------------------------------

### Uninstall Coral on Windows (ZIP Install)

Source: https://withcoral.com/docs/getting-started/installation

Remove Coral executable and configuration files for a Windows ZIP installation.

```powershell
Remove-Item "$env:USERPROFILE\.local\bin\coral.exe" -ErrorAction SilentlyContinue
Remove-Item "$env:APPDATA\withcoral\coral\config" -Recurse -Force -ErrorAction SilentlyContinue
```

--------------------------------

### Create Sample JSONL Data

Source: https://withcoral.com/docs/guides/write-a-custom-source

Shell script to create a directory and a sample messages.jsonl file containing user and assistant messages for a local source demo.

```shellscript
mkdir -p demo-data
cat > demo-data/messages.jsonl <<'EOF'
{"type":"user","session_id":"s1","text":"hello"}
{"type":"assistant","session_id":"s1","text":"world"}
EOF
```

--------------------------------

### Get Information on a Specific Coral Source

Source: https://withcoral.com/docs/project/security

Use this command to get detailed information about a specific Coral source, including its secret storage method.

```bash
coral source info <NAME>
```

--------------------------------

### Upgrade Coral on Windows using ZIP

Source: https://withcoral.com/docs/getting-started/installation

Download the latest ZIP, expand it, and overwrite the existing coral.exe to upgrade.

```powershell
Invoke-WebRequest `
  -Uri "https://github.com/withcoral/coral/releases/latest/download/coral-x86_64-pc-windows-msvc.zip" `
  -OutFile "coral-x86_64-pc-windows-msvc.zip"
Expand-Archive -Path "coral-x86_64-pc-windows-msvc.zip" -DestinationPath "coral" -Force
Copy-Item "coral\coral.exe" "$env:USERPROFILE\.local\bin\coral.exe"
```

--------------------------------

### Enable Runtime Feature

Source: https://withcoral.com/docs/reference/configuration

Configure experimental runtime features by setting boolean values under the `[features]` section in `config.toml`. Unknown feature keys are preserved but ignored.

```toml
[features]
feedback = true
```

--------------------------------

### Configure a file-backed table with JSONL format

Source: https://withcoral.com/docs/reference/source-spec-reference

Define a table using the 'file' backend, specifying 'jsonl' format, a source location, and glob pattern. Columns must be declared.

```yaml
name: local_messages
version: 0.1.0
dsl_version: 3
backend: file
tables:
  - name: messages
    description: Demo messages
    format: jsonl
    source:
      location: file:///absolute/path/to/demo-data/
      glob: "**/*.jsonl"
    columns:
      - name: type
        type: Utf8
      - name: session_id
        type: Utf8
      - name: text
        type: Utf8
```

--------------------------------

### List Available Coral Sources

Source: https://withcoral.com/docs/project/security

Use this command to list all configured Coral sources. This helps in inspecting their security settings.

```bash
coral source list
```

--------------------------------

### Enable Local HTTP Body Recording

Source: https://withcoral.com/docs/guides/observe-with-opentelemetry

To enable recording of HTTP request and response body previews in local trace history, set `record_http_bodies` to `true` within the `[trace_history]` section of `config.toml`. Note that these previews are capped by `http_body_max_bytes` and are never exported to OTLP.

```toml
[trace_history]
record_http_bodies = true

```

--------------------------------

### Generate Coral shell completion script for Zsh

Source: https://withcoral.com/docs/reference/cli-reference

Generates a Zsh shell completion script for Coral and saves it to the specified file path for installation.

```shellscript
coral completion zsh > ~/.zsh/completions/_coral
```

--------------------------------

### Extracting Rows with rows_path

Source: https://withcoral.com/docs/reference/source-spec-reference

Use `rows_path` to specify a JSON path to the array of rows within the HTTP response body. This example targets `response_body.data.items`.

```yaml
response:
  rows_path:
    - data
    - items
  row_strategy: direct
```

--------------------------------

### Download and Extract Windows ZIP

Source: https://withcoral.com/docs/getting-started/installation

Download the Windows x86_64 release ZIP and extract it to a local directory.

```powershell
Invoke-WebRequest `
  -Uri "https://github.com/withcoral/coral/releases/latest/download/coral-x86_64-pc-windows-msvc.zip" `
  -OutFile "coral-x86_64-pc-windows-msvc.zip"
Expand-Archive -Path "coral-x86_64-pc-windows-msvc.zip" -DestinationPath "coral" -Force
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.local\bin"
Copy-Item "coral\coral.exe" "$env:USERPROFILE\.local\bin\coral.exe"
```

--------------------------------

### Configure OpenTelemetry Export

Source: https://withcoral.com/docs/reference/configuration

Set up external OpenTelemetry export by configuring the `[otel]` section in `config.toml`. This includes specifying the endpoint, headers, and filters for logs and traces.

```toml
[otel]
endpoint = "http://localhost:4318"
headers = "authorization=Bearer ..."
log_filter = "info"
trace_filter = "coral_app=debug"
service_name = "coral"
```

--------------------------------

### Inspecting Flattened Column Names

Source: https://withcoral.com/docs/reference/source-spec-reference

Shows how to query the `coral.columns` system table to inspect available flattened column names and their descriptions for a given schema and table.

```sql
SELECT column_name, description
FROM coral.columns
WHERE schema_name = 'github' AND table_name = 'issues'
ORDER BY ordinal_position
```

--------------------------------

### Add Community Source Interactively

Source: https://withcoral.com/docs/reference/community-sources

Import a community source using its manifest file and enable interactive prompts for any declared inputs. This is useful when inputs are not set as environment variables.

```shellscript
coral source add --interactive --file sources/community/fly/manifest.yaml
```

--------------------------------

### Open the local Coral UI

Source: https://withcoral.com/docs/reference/cli-reference

Launches the local Coral user interface in the default web browser. The UI is accessible at http://127.0.0.1:1457 by default.

```shellscript
coral ui
```

--------------------------------

### Add GitHub Source via Environment Variables

Source: https://withcoral.com/docs/getting-started/quickstart

Adds the GitHub source to Coral by reading credentials from environment variables. This is suitable for scripted or automated setups.

```shellscript
GITHUB_TOKEN=ghp_... coral source add github
```

--------------------------------

### Configure HTTP API Source with OAuth

Source: https://withcoral.com/docs/guides/write-a-custom-source

Set up an HTTP API source to use OAuth for authentication. This allows users to connect via OAuth or by pasting a token, with the `auth` block handling the token's usage.

```yaml
inputs:
  DEMO_API_TOKEN:
    kind: secret
    hint: Access token for the Demo API. Use OAuth setup or paste a token with read access.
    credential:
      methods:
        - type: oauth
          label: Connect with Demo
          description: Open a browser and authorize Coral to read Demo API data.
          oauth:
            flow:
              type: authorization_code
              pkce: required
            redirect_uri: http://127.0.0.1:0/oauth/callback
            redirect_uri_port_mode: random
            endpoints:
              authorization_url: https://demo.example.com/oauth/authorize
              token_url: https://demo.example.com/oauth/token
            client:
              id:
                input: DEMO_OAUTH_CLIENT_ID
            scopes:
              scope:
                delimiter: space
                values:
                  - read:data
        - type: source_config
          label: Paste token
auth:
  type: HeaderAuth
  headers:
    - name: Authorization
      from: template
      template: Bearer {{input.DEMO_API_TOKEN}}
```

--------------------------------

### Validate a Source Spec File

Source: https://withcoral.com/docs/reference/cli-reference

Validate a source spec YAML file without installing it. This command checks for YAML syntax, JSON schema conformance, and semantic rules.

```shellscript
coral source lint ./my-source.yaml
```

--------------------------------

### Add and Test a Community Source

Source: https://withcoral.com/docs/reference/community-sources

Add a community source by specifying its manifest file path. After adding, test the source to ensure it is correctly imported and functional.

```shellscript
coral source add --file sources/community/hn/manifest.yaml
coral source test hn
```

--------------------------------

### Run a Query and Verify Signals

Source: https://withcoral.com/docs/guides/observe-with-opentelemetry

Execute any query using the Coral CLI and confirm that telemetry signals, including traces, counters, and histograms, are successfully reaching your OpenTelemetry backend. Ensure your OTLP collector is configured correctly.

```shell
coral sql "SELECT 1"
```

--------------------------------

### Enable Coral shell completions in the current Bash session

Source: https://withcoral.com/docs/reference/cli-reference

Sources the output of the Coral completion command for Bash directly into the current shell session, enabling completions without installation.

```shellscript
source <(coral completion bash)
```

--------------------------------

### Define HTTP API Source with Basic Token Auth

Source: https://withcoral.com/docs/guides/write-a-custom-source

Configure an HTTP API source with base URL, token authentication for the Authorization header, and define tables with request/response details. Use this for simple API integrations.

```yaml
name: demo_api
version: 0.1.0
dsl_version: 3
backend: http
inputs:
  API_BASE:
    kind: variable
    default: https://api.example.com
    hint: Base URL for the API
  API_TOKEN:
    kind: secret
    hint: Bearer token for the API
base_url: "{{input.API_BASE}}"
auth:
  type: HeaderAuth
  headers:
    - name: Authorization
      from: template
      template: Bearer {{input.API_TOKEN}}
tables:
  - name: messages
    description: Messages from the API
    request:
      method: GET
      path: /messages
    response:
      rows_path:
        - data
    pagination:
      mode: link_header
      page_size:
        default: 50
        max: 100
        query_param: per_page
    columns:
      - name: id
        type: Utf8
      - name: text
        type: Utf8
      - name: created_at
        type: Utf8
```

--------------------------------

### List All Available Tables

Source: https://withcoral.com/docs/getting-started/quickstart

Queries Coral to display all available tables across connected data sources. Use this to understand your data schema.

```shellscript
coral sql "SELECT schema_name, table_name FROM coral.tables ORDER BY 1, 2"
```

--------------------------------

### search_issues HTTP Table Function

Source: https://withcoral.com/docs/reference/source-spec-reference

Defines a table function for searching provider issues using HTTP GET requests. It supports query parameters for search terms and types, and specifies response mapping and pagination.

```APIDOC
## search_issues

### Description
Search provider issues.

### Kind
search

### Search Limits
- default_top_k: 10
- max_top_k: 100
- max_calls_per_query: 1

### Arguments
- **q** (string) - Required - The search query string.
- **mode** (string) - Optional - The search mode. Allowed values: [lexical, semantic, hybrid].

### Request
- **Method**: GET
- **Path**: /search/issues
- **Query Parameters**:
  - **q** (string) - from: arg - The search query string.
  - **search_type** (string) - from: arg - The search mode.

### Response
- **rows_path**: [items]
- **allow_404_empty**: false
- **row_strategy**: direct

### Columns
- **id** (Utf8)
- **title** (Utf8)
- **html_url** (Utf8)
- **score** (Float64)

### Pagination
- **Mode**: page
- **Page Size**:
  - default: 30
  - max: 100
  - query_param: per_page
- **Page Parameter**: page
- **Page Start**: 1
- **Page Step**: 1
- **Offset Start**: 0
- **Link Header Require Results**: false
```

--------------------------------

### Enable OpenTelemetry Export

Source: https://withcoral.com/docs/guides/observe-with-opentelemetry

Add an `[otel]` section to your `config.toml` file to enable exporting traces, logs, and metrics to an OTLP/HTTP endpoint. Coral automatically appends the correct signal paths.

```toml
[otel]
endpoint = "http://localhost:4318"

```

--------------------------------

### Build Coral CLI for Windows

Source: https://withcoral.com/docs/getting-started/installation

Compile the Coral CLI for Windows x86_64 using Cargo. This requires Git for Windows, Rust with MSVC toolchain, Visual Studio Build Tools, and Windows SDK.

```powershell
cargo build --release --locked -p coral-cli
```

--------------------------------

### Configure Coral MCP server in Claude Desktop config

Source: https://withcoral.com/docs/guides/use-coral-over-mcp

Manually configure the Coral MCP server in Claude Desktop's user-scoped configuration file.

```json
{
  "mcpServers": {
    "coral": {
      "command": "coral",
      "args": ["mcp-stdio"]
    }
  }
}
```

--------------------------------

### Windows Compiled Binary Path

Source: https://withcoral.com/docs/getting-started/installation

Locate the compiled Coral CLI binary after building from source for Windows.

```text
target\release\coral.exe
```

--------------------------------

### Add and Test Custom Source

Source: https://withcoral.com/docs/guides/write-a-custom-source

Shell commands to add a custom source definition file and then test the source using Coral's command-line interface.

```shellscript
coral source add --file ./local-messages.yaml
coral source test local_messages
```

--------------------------------

### HTTP-backed Table Configuration

Source: https://withcoral.com/docs/reference/source-spec-reference

Defines an HTTP-backed table, specifying base URL, authentication, and request/response behavior. Uses inputs for dynamic configuration like API base URL and tokens.

```yaml
name: demo_api
version: 0.1.0
dsl_version: 3
backend: http
inputs:
  API_BASE:
    kind: variable
    default: https://api.example.com
  API_TOKEN:
    kind: secret
base_url: "{{input.API_BASE}}"
auth:
  type: HeaderAuth
  headers:
    - name: Authorization
      from: template
      template: Bearer {{input.API_TOKEN}}
tables:
  - name: messages
    description: Messages from the demo API
    request:
      method: GET
      path: /messages
    response: {}
    columns:
      - name: id
        type: Utf8
      - name: text
        type: Utf8
```

--------------------------------

### List Runtime Features

Source: https://withcoral.com/docs/reference/configuration

Inspect available features and their effective state using the `coral features list` command.

```shellscript
coral features list
```

--------------------------------

### Clone Coral Repository

Source: https://withcoral.com/docs/reference/community-sources

Clone the Coral repository to access community source specifications locally. Navigate into the cloned directory to use the `coral` CLI commands.

```shellscript
git clone https://github.com/withcoral/coral.git
cd coral
```

--------------------------------

### Add a Custom Source from a File

Source: https://withcoral.com/docs/reference/cli-reference

Add a custom source specification from a YAML file. Input values are sourced from environment variables by default, or interactively if `--interactive` is specified.

```shellscript
coral source add --file ./local-messages.yaml
```

--------------------------------

### File Path Partitioning (Hive-style)

Source: https://withcoral.com/docs/reference/source-spec-reference

Defines file-backed table partitions using Hive-style path segments. Supports Utf8, Int64, Boolean, and Float64 partition types. Assumes paths like 'year=2026/month=05/events.jsonl'.

```yaml
source:
  location: file:///absolute/path/to/events/
  glob: "**/*.jsonl"
  partitions:
    - name: year
      type: Int64
    - name: month
      type: Int64
```

--------------------------------

### Input Variables and Secrets Configuration

Source: https://withcoral.com/docs/reference/source-spec-reference

Defines input variables and secrets for a source, including a default base URL and an API token. Sets up authorization headers using these inputs.

```yaml
inputs:
  API_BASE:
    kind: variable
    default: https://api.example.com
    hint: Base URL for the API
  API_TOKEN:
    kind: secret
    hint: API bearer token

base_url: "{{input.API_BASE}}"
auth:
  type: HeaderAuth
  headers:
    - name: Authorization
      from: template
      template: Bearer {{input.API_TOKEN}}
```

--------------------------------

### Configure Basic Authentication

Source: https://withcoral.com/docs/reference/source-spec-reference

Configures HTTP Basic Authentication by providing username and password templates. Coral will base64-encode these credentials for the Authorization header.

```yaml
auth:
  type: BasicAuth
  username: "{{input.API_USER}}"
  password: "{{input.API_TOKEN}}"
```

--------------------------------

### Configure OTLP Endpoint and Headers

Source: https://withcoral.com/docs/guides/observe-with-opentelemetry

Use this TOML configuration to set the OTLP endpoint, authentication headers, service name, and trace filters for exporting traces.

```toml
[otel]
endpoint = "https://otlp.example.com"
headers = "x-api-key=secret, x-tenant=acme"
service_name = "coral-laptop"
trace_filter = "coral_app=trace,coral_client=trace,coral_mcp=trace,coral_engine=trace"
```

--------------------------------

### Enable DataFusion Tracing

Source: https://withcoral.com/docs/guides/observe-with-opentelemetry

Enable OTLP export for DataFusion execution and optimizer-rule spans by including 'coral_engine::datafusion=trace' in the trace filter.

```toml
[otel]
endpoint = "http://localhost:4318"
trace_filter = "coral_app=trace,coral_client=trace,coral_mcp=trace,coral_engine=trace,coral_engine::datafusion=trace"
```
Tokens:
Raw