datahub-connector-planning

Plan DataHub connectors by classifying sources and generating a _PLANNING.md blueprint.

36|86|Updated Feb 25, 2026
One-click install
npx skills add https://github.com/datahub-project/datahub-skills --skill datahub-connector-planning
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: datahub-connector-planning
Source: https://github.com/datahub-project/datahub-skills/tree/main/skills/datahub-connector-planning
Command: npx skills add https://github.com/datahub-project/datahub-skills --skill datahub-connector-planning

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and templates (resource) components.

What problem does it solve?

This Skill streamlines the complex process of planning and designing new DataHub connectors, ensuring robust and well-documented implementations.

Core Features & Use Cases

  • Guided Planning Workflow: Walks users through classifying, researching, and documenting connector requirements.
  • Architecture & Entity Mapping: Provides clear guidance on base class selection, entity mapping, and configuration design based on DataHub standards.
  • Use Case: A new DataHub user needs to build a connector for a custom API. They activate this Skill, which guides them through researching the API, defining the metadata entities to extract, and creating a comprehensive _PLANNING.md document before any code is written.

Quick Start

Use the datahub-connector-planning skill to plan a new DataHub connector for the ClickHouse database.

Frequently Asked Questions about datahub-connector-planning

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I plan a DataHub connector for a new data source?

To plan a DataHub connector, you need to classify the source system, gather requirements, and design the architecture. This Skill guides you through this workflow to generate a detailed `_PLANNING.md` blueprint covering entity mapping and base class selection.

What metadata entities should I extract when building a DataHub connector?

Extracting metadata entities for DataHub connectors requires mapping source system attributes to DataHub standards. The Skill provides architecture and entity mapping guidance to help you define exactly which metadata structures to capture for SQL, API, or NoSQL sources.

Does this DataHub connector planning workflow support NoSQL and API sources?

Yes, DataHub connector planning supports SQL, API, and NoSQL sources. The workflow leverages DataHub reference documents and standards to guide the classification and requirements gathering for these specific source system types.

How do I select the right base class for a custom DataHub connector?

Selecting the right base class for a DataHub connector involves matching your source system characteristics with DataHub architecture standards. The Skill provides clear guidance on base class selection and configuration design based on official reference documents.

What is the best way to document DataHub connector requirements before writing code?

The best way to document DataHub connector requirements is to generate a comprehensive `_PLANNING.md` blueprint. This Skill facilitates source system research and requirements gathering to produce this detailed architectural document before implementation begins.

Why do I need a planning document before developing a DataHub ingestion connector?

A planning document is needed before developing a DataHub ingestion connector to ensure robust and well-documented implementations. It streamlines the complex design process by defining architecture, entity mapping, and configuration requirements upfront.