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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add read_lance docs #2218

Merged
merged 2 commits into from
May 2, 2024
Merged

[DOCS] Add read_lance docs #2218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0836036
[DOCS] Add read_lance docs
May 2, 2024
e153039
Add some extra docs
May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions daft/io/_lance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ def read_lance(url: str, io_config: Optional["IOConfig"] = None) -> DataFrame:
This function requires the use of `LanceDB <https://lancedb.github.io/lancedb/>`_, which is the Python
library for the LanceDB project.

To ensure that this is installed with Daft, you may install: ``pip install getdaft[lance]``

Example:

>>> df = daft.read_lance("s3://my-lancedb-bucket/data/")
>>> df.show()

Args:
url: URL to the LanceDB table (supports remote URLs to object stores such as `s3://` or `gs://`)
io_config: A custom IOConfig to use when accessing LanceDB data. Defaults to None.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/api_docs/creation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,5 @@ Databases
:nosignatures:
:toctree: doc_gen/io_functions

read_sql
read_sql
read_lance
Loading