Skip to content

feature: Add method to describe consumer in YDB Python SDK via gRPC API #683

Open
@krasnovdm

Description

@krasnovdm

Add method to describe consumer in YDB Python SDK via gRPC API

Feature Request

Implement a method in the YDB Python SDK to retrieve information about a consumer via gRPC API. Currently, there is no direct method in the SDK that allows sending a DescribeConsumerRequest and obtaining consumer information similar to what is provided by the CLI command.

Preferred Solution

Add a method to the Python SDK that sends a DescribeConsumerRequest via gRPC and returns information about the consumer, including partition statistics. The method should accept the following parameters:

  • topic_path — the path to the topic;
  • consumer_name — the name of the consumer;
  • include_partition_stats — a flag to include partition statistics.

Alternatives

As an alternative, one can continue using low-level interaction with gRPC, manually forming and sending requests. However, this is less convenient and requires additional effort to process responses.

This enhancement will simplify working with consumers in YDB for developers using the Python SDK, making the process more convenient and straightforward.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions