generate-client

Dataverse Generate Client Command

Generate typed Python client code for a specific Dataverse table.

Instructions

When the user runs /dataverse:generate-client <table>:

1. Get table schema

   • Use dataverse_get_table_info to get columns and types
   • Extract column names, types, and metadata

2. Generate Pydantic models

   • Create model class for the table
   • Map Dataverse types to Python types
   • Add Optional for nullable fields

3. Generate client class

   • CRUD methods for the table
   • Type hints for all parameters and returns
   • Docstrings with examples

4. Write output file

   • Default: <table>_client.py
   • Include all imports

Type Mapping

Generated Code Template

"""
Auto-generated Dataverse client for {table_name}
Generated by dataverse plugin
"""

from dataclasses import dataclass
from typing import Optional, List
from datetime import datetime
from decimal import Decimal
from PowerPlatform.Dataverse.client import DataverseClient

@dataclass
class {TableClass}:
    """{table_name} record model."""
    {table_id}: Optional[str] = None
    {columns}

class {TableClass}Client:
    """Client for {table_name} operations."""

    def __init__(self, client: DataverseClient):
        self.client = client
        self.table = "{table_schema_name}"

    def create(self, record: {TableClass}) -> str:
        """Create a new {table_name} record."""
        data = {k: v for k, v in record.__dict__.items() if v is not None}
        ids = self.client.create(self.table, data)
        return ids[0]

    def get(self, record_id: str) -> {TableClass}:
        """Get a {table_name} record by ID."""
        data = self.client.get(self.table, record_id)
        return {TableClass}(**data)

    def update(self, record_id: str, updates: dict) -> None:
        """Update a {table_name} record."""
        self.client.update(self.table, record_id, updates)

    def delete(self, record_id: str) -> None:
        """Delete a {table_name} record."""
        self.client.delete(self.table, record_id)

    def list(self, filter: str = None, top: int = 100) -> List[{TableClass}]:
        """List {table_name} records."""
        pages = self.client.get(self.table, filter=filter, top=top)
        records = []
        for page in pages:
            records.extend([{TableClass}(**r) for r in page])
        return records