Skip to content

Make it easier to register object stores #10616

@alamb

Description

@alamb

Came up in #9280

The problem is that when trying to use urls in ListingTables (or ParquetExec), if you try with a scheme like file:// it won't work unless you have registered an object store handler

However, the current user experience is bad -- the error message is mysterious and confusing and it is not obvious how to register the correct listing table

"Error: Internal("No suitable object store found for file://")"

I would recommend two things:

Suggestion 1: Change the error message

Change the error message to include instructions on how to fix the issue

For example, instead of

No suitable object store found for file://

Perhaps it could be something more like

No object store registered for url scheme 'file://'. See RuntimeEnv::register_object_store

Suggestion 2: Add an example to the docs

Once the error message directs to RuntimeEnv::register_object_store then it would be ideal if the docs

https://docs.rs/datafusion/latest/datafusion/execution/runtime_env/struct.RuntimeEnv.html#method.register_object_store

actually had an example

So that would perhaps take the form of adapting the example above as a doc example

Does that make sense?

Originally posted by @alamb in #9280 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions