Linear

Linear source connector

Description

The Linear source connector reads data from the Linear GraphQL API. It is based on the HTTP source connector and sends the configured api_key as the Authorization request header, as required by the Linear API.

Key Features

• batch
• stream
• exactly-once
• column projection
• parallelism
• support user-defined split

Source Options

Name	Type	Required	Default	Description
url	String	Yes	-	Linear API endpoint URL, usually https://api.linear.app/graphql.
api_key	String	Yes	-	Linear API key. The connector sends it verbatim as the Authorization request header value; no Bearer prefix is added, so OAuth access tokens must be configured as api_key = "Bearer <token>".
method	String	No	get	HTTP request method. Supported values are GET and POST.
headers	Map	No	-	Extra HTTP headers. Any Authorization entry here is always replaced by the value of api_key.
params	Map	No	-	Query parameters sent with the request.
body	String	No	-	HTTP request body. Usually used with method = "POST" to send a GraphQL query.
format	String	No	text	Response format. Use json when reading the GraphQL response into a SeaTunnel schema; use text to return the raw response as content. The shared HTTP option also accepts binary, but binary is not supported by the Linear source and binary_chunk_size has no effect here.
schema	Config	No	-	Output schema. Required when format = "json".
schema.fields	Config	No	-	Field names and SeaTunnel data types used to parse the JSON response.
content_field	String	No	-	JSONPath used to select a nested part of the response before parsing it with schema, for example $.data.issues.nodes.*.
json_field	Config	No	-	Field-level JSONPath mapping. Use it with schema when output fields come from different JSON paths.
retry	Int	No	-	Maximum retry times when the HTTP request fails with an IOException.
retry_backoff_multiplier_ms	Int	No	100	Retry backoff multiplier in milliseconds. Takes effect only when retry is configured.
retry_backoff_max_ms	Int	No	10000	Maximum retry backoff in milliseconds. Takes effect only when retry is configured.
enable_multi_lines	Boolean	No	false	When true, multiple JSON objects separated by newlines in the response body are treated as separate records.
keep_params_as_form	Boolean	No	false	When true, request parameters are sent as form-encoded body parameters instead of URL query parameters.
connect_timeout_ms	Int	No	12000	HTTP connection timeout in milliseconds.
socket_timeout_ms	Int	No	60000	HTTP socket timeout in milliseconds.
json_filed_missed_return_null	Boolean	No	false	Return null when a configured JSON field is missing.
common-options	Config	No	-	Source plugin common parameters. See Source Common Options.

tip

api_key is a sensitive credential. Unlike options such as password or access_key, api_key is not masked in parsed-config logs and is not encrypted or decrypted by default. To protect the value, add api_key to env.shade.options and encrypt it with the configured shade.identifier. See Config Encryption and Decryption.

Usage Notes

• The plugin name in the job configuration is Linear.
• Set format = "json" and configure schema when you want typed SeaTunnel rows.
• Use content_field to unwrap the GraphQL envelope, for example $.data.issues.nodes.*, before parsing with schema.
• Use json_field only when each output field needs its own JSONPath expression.
• Pagination is not supported by this connector. Each job reads only what a single request returns; the HTTP pageing block and its options have no effect here.
• api_key is sent verbatim as the Authorization header value and always overrides any Authorization entry in headers. Put only other custom headers in headers.

Task Examples

Read Issues

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  Linear {
    url = "https://api.linear.app/graphql"
    api_key = "<your_linear_api_key>"
    method = "POST"
    body = "{\"query\": \"{ issues { nodes { id title } } }\"}"
    format = "json"
    content_field = "$.data.issues.nodes.*"
    schema = {
      fields {
        id = string
        title = string
      }
    }
    plugin_output = "linear_data"
  }
}

sink {
  Console {
  }
}

Extract Fields With JSONPath

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  Linear {
    url = "https://api.linear.app/graphql"
    api_key = "<your_linear_api_key>"
    method = "POST"
    body = "{\"query\": \"{ issues { nodes { id title } } }\"}"
    format = "json"
    json_field = {
      id = "$.data.issues.nodes[*].id"
      title = "$.data.issues.nodes[*].title"
    }
    schema = {
      fields {
        id = string
        title = string
      }
    }
  }
}

Changelog

Change Log

Change	Commit	Version
[Feature][Connector-V2] Add Linear HTTP source connector	https://github.com/apache/seatunnel/commit/56cfbca0fb	Next