Skip to content

README.md: List all unimplemented API functions #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025

Conversation

wprzytula
Copy link
Collaborator

All functions present in cassandra.h that are not implemented in the CPP-Rust Driver are now listed in the README.md file.

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • PR description sums up the changes and reasons why they should be introduced.
    - [ ] I have implemented Rust unit tests for the features/changes introduced.
    - [ ] I have enabled appropriate tests in Makefile in {SCYLLA,CASSANDRA}_(NO_VALGRIND_)TEST_FILTER.

@wprzytula wprzytula requested review from Lorak-mmk and Copilot June 11, 2025 21:15
@wprzytula wprzytula self-assigned this Jun 11, 2025
@wprzytula wprzytula added this to the 0.5 milestone Jun 11, 2025
Copilot

This comment was marked as outdated.

All functions present in `cassandra.h` that are not implemented
in the CPP-Rust Driver are now listed in the README.md file.
@wprzytula wprzytula force-pushed the readme-full-unimplemented-list branch from 60f1eca to ddf1a5f Compare June 11, 2025 21:30
@wprzytula wprzytula requested a review from Copilot June 11, 2025 21:30
@wprzytula wprzytula added the documentation Improvements or additions to documentation label Jun 11, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the README by clarifying the limitations note and adding a comprehensive list of unimplemented Cassandra API functions.

  • Refines the “Limitations” note wording for clarity
  • Introduces a new “Unimplemented functions from cassandra.h” section
  • Enumerates missing driver functions by API group
Comments suppressed due to low confidence (2)

README.md:303

  • Duplicate entry 'cass_function_meta_body' appears twice under CassFunctionMeta. Remove the redundant line to avoid confusion.
- cass_function_meta_body

README.md:286

  • [nitpick] Heading 'CassColumn' is missing a colon suffix for consistency with other section headings. Add ':' after the heading.
#### CassColumn

@Lorak-mmk
Copy link
Collaborator

I think we should list reasons for why something is unimplemented. Some (maybe not all) possible reasons:

  • Planned, not yet done
  • Functionality not present in Scylla
  • Deprecated in cpp-driver
  • Deprecated and noop in cpp-driver

@wprzytula
Copy link
Collaborator Author

I think we should list reasons for why something is unimplemented. Some (maybe not all) possible reasons:

* Planned, not yet done

* Functionality not present in Scylla

* Deprecated in cpp-driver

* Deprecated and noop in cpp-driver

Agreed. I'll do that in a follow-up, OK?

@wprzytula wprzytula merged commit 91b67d5 into scylladb:master Jun 17, 2025
12 checks passed
@wprzytula wprzytula deleted the readme-full-unimplemented-list branch June 17, 2025 16:08
@wprzytula wprzytula mentioned this pull request Jun 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants