Skip to content
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

Minor: Move MemoryCatalog*Provider into a module, improve comments #11183

Merged
merged 3 commits into from
Jul 2, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 30, 2024

Which issue does this PR close?

part of #11182

Rationale for this change

There is a distinction between catalog API (the traits) and the provided simple implementations (e.g. MemoryCatalogProvider*) that is not well reflected in the module structure now.

If we make the code structure better mirror the distinction, it will both be clearer and set us up for future simplifications

What changes are included in this PR?

  1. Move MemoryCatalog*Provider into a module
  2. Improve doc comments
  3. Leave backwards compatible pub use

Are these changes tested?

With existing CI

Are there any user-facing changes?

Better docs, no functional change

@github-actions github-actions bot added the core Core datafusion crate label Jun 30, 2024
// specific language governing permissions and limitations
// under the License.

//! [`MemoryCatalogProvider`], [`MemoryCatalogProviderList`]: In-memory implementations of [`CatalogListProvider`] and [`CatalogProvider`]:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The point of the PR is to move the memory implementations into this module

Copy link
Member

@jonahgao jonahgao left a comment

Choose a reason for hiding this comment

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

Looks good to me

pub mod schema;

pub use memory::{
Copy link
Member

Choose a reason for hiding this comment

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

👍

@alamb
Copy link
Contributor Author

alamb commented Jul 2, 2024

Thank you for the review @jonahgao

@alamb alamb merged commit a4796fa into apache:main Jul 2, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core datafusion crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants