Mooncake
Mooncake copied to clipboard
[store] add pybind for get_replica_desc
Description
- There is a
Queryfuncs inclient_service.cpp, which providing query replica_descriptor ability. But I haven't seen a pybind interface that provides this implementation. And I want to query replica_descriptor to do some cache aware route, so i implement it.
Type of Change
- Types
- [ ] Bug fix
- [ ] New feature
- [ ] Transfer Engine
- [x] Mooncake Store
- [ ] Mooncake EP
- [x] Integration
- [ ] P2P Store
- [ ] Python Wheel
- [ ] Breaking change
- [ ] CI/CD
- [ ] Documentation update
- [ ] Other
How Has This Been Tested?
from mooncake.store import MooncakeDistributedStore
store_client = MooncakeDistributedStore()
store_client .setup() # add init config
descriptors = store.get_replica_desc("mooncake_key")
for desc in descriptors:
print("Status:", desc.status)
if desc.is_memory_replica():
mem_desc = desc.get_memory_descriptor()
print("Memory buffer desc:", mem_desc.buffer_descriptor)
elif desc.is_disk_replica():
disk_desc = desc.get_disk_descriptor()
print("Disk path:", disk_desc.file_path, "Size:", disk_desc.object_size)
Checklist
- [x] I have performed a self-review of my own code.
- [x] I have updated the documentation.
- [x] I have added tests to prove my changes are effective.
Summary of Changes
Hello @yejj710, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the Mooncake store's Python integration by providing new functionalities to retrieve replica descriptors. It exposes the AllocatedBuffer::Descriptor class to Python and adds methods to fetch replica information for specified keys, facilitating more direct interaction with the store's data management from Python applications.
Highlights
- Python Bindings for Replica Descriptors: Introduced Python bindings for
AllocatedBuffer::Descriptor, allowing Python clients to interact with memory descriptors directly. - New
get_replicaFunctionality: Addedget_replicaandbatch_get_replicamethods to the Python interface, enabling retrieval of replica descriptors for single or multiple keys from the Mooncake store. - C++
RealClientImplementation: Implemented the underlying C++get_replicaandbatch_get_replicamethods inRealClient, which query the store and return lists or maps ofReplica::Descriptorobjects.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Last thing: make this PR consistent with #1148; it also uses replica desc.
Please double-check this PR. CC. @ykwd @YiXR
LGTM