OpenMetadata/ingestion/SDK_IMPLEMENTATION_PLAN.md

OpenMetadata Python SDK Implementation Plan

Current Status

✅ Completed (15 entities):

• Table
• Database
• DatabaseSchema
• Dashboard
• Pipeline
• Container
• Topic
• Team
• User
• Glossary
• GlossaryTerm
• Chart (NEW)
• Metric (NEW)
• MLModel (IN PROGRESS)

Remaining High-Priority Entities (20)

Data Assets (Priority 1)

• StoredProcedure
• SearchIndex
• Query
• DashboardDataModel
• APIEndpoint
• APICollection

Governance (Priority 2)

• Classification
• Tag
• Domain
• DataProduct

Data Quality (Priority 3)

• TestCase
• TestSuite
• TestDefinition
• DataContract

Security (Priority 4)

• Role
• Policy
• PersonalAccessToken

Operations (Priority 5)

• IngestionPipeline
• Workflow
• Alert

Implementation Strategy

Each entity needs:

1. Entity class with full CRUD operations
2. Comprehensive unit tests (15-20 test cases)
3. Integration with base entity pattern
4. Proper error handling
5. CSV import/export support
6. Version management
7. Follower management
8. Custom operations specific to entity type

Test Coverage Requirements

• Create operations
• Retrieve by ID and name
• Update and patch operations
• Delete (soft and hard)
• List with pagination
• Add/remove followers
• Version management
• Error handling
• Entity-specific operations

Next Steps

1. Complete MLModel implementation and tests
2. Implement remaining data asset entities
3. Add governance entities
4. Implement data quality entities
5. Add security entities
6. Create comprehensive integration tests
7. Update documentation
8. Performance optimization