connector-sdk

Extend Apache Iggy Connectors SDK with schema variants, stream codecs, and error types.

4.5k|375|Updated Mar 18, 2023
One-click install
npx skills add https://github.com/apache/iggy --skill connector-sdk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: connector-sdk
Source: https://github.com/apache/iggy/tree/main/.claude/skills/connector-sdk
Command: npx skills add https://github.com/apache/iggy --skill connector-sdk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires rust, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

The connector-sdk Skill Unit extends and modifies the Apache Iggy Connectors SDK, enabling developers to add new schemas, stream decoders/encoders, error variants, and more, ensuring the SDK meets specific needs.

Core Features & Use Cases

  • Schema Variant Creation: Add new Schema variants to the SDK for extended functionality.
  • Stream Decoding and Encoding: Customize decoding and encoding logic with StreamDecoder and StreamEncoder interfaces.
  • Error Variant Definition: Extend the SDK's error handling by defining new Error variants.
  • FFI Integration: Work with FFI (Foreign Function Interface) to ensure compatibility between SDK and external plugins.
  • Retry Mechanisms: Utilize retry logic to handle transient failures and ensure robust SDK behavior.
  • SDK Version Management: Bump SDK versions carefully while managing backwards compatibility.

Quick Start

Run 'iggy connectors setup connector-sdk' to get started with custom connector SDK modifications.

Frequently Asked Questions about connector-sdk

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

FAQPage Schema
How do I add custom schema variants to Apache Iggy connectors?

To add custom schema variants to Apache Iggy connectors, use the connector-sdk to define new Schema variants tailored to specific deployment scenarios. Run 'iggy connectors setup connector-sdk' to begin modifications.

Can I customize stream decoding and encoding logic in an SDK?

Yes, you can customize stream decoding and encoding logic by implementing custom StreamDecoder and StreamEncoder interfaces. This ensures the SDK meets specific data processing needs for your connectors.

Does the connector-sdk require Rust to manage FFI integration?

Yes, the connector-sdk requires Rust as a dependency to manage FFI integration. It ensures compatibility between the SDK and external plugins by leveraging Rust's foreign function interface capabilities.

What is the best way to handle transient failures in Apache Iggy connectors?

The best way to handle transient failures in Apache Iggy connectors is to utilize the connector-sdk's built-in retry mechanisms. This ensures robust SDK behavior by automatically managing transient errors during execution.

How do I define new error variants for SDK extensibility?

To define new error variants for SDK extensibility, use the connector-sdk to extend the SDK's error handling capabilities. This allows you to define new Error variants for specific development scenarios.

Why should I bump SDK versions when modifying Apache Iggy connectors?

You should bump SDK versions when modifying Apache Iggy connectors to carefully manage backwards compatibility. This practice ensures that new schema variants and error types do not break existing integrations.