daft-lance 0.1.0__tar.gz

daft_lance-0.1.0/.github/workflows/pr-test-suite.yml

@@ -0,0 +1,19 @@
+name: PR Test Suite
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Run tests
+        run: uv run --python ${{ matrix.python-version }} pytest tests/ -v

daft_lance-0.1.0/.github/workflows/publish-package.yml

@@ -0,0 +1,18 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

daft_lance-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

daft_lance-0.1.0/LICENSE

@@ -0,0 +1,199 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an
+      "Whose License Is It Anyway?" lawyer to review your project.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

daft_lance-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: daft-lance
+Version: 0.1.0
+Summary: Lance integration for Daft - compaction, indexing, merge columns, and REST operations
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: daft>=0.7.5
+Requires-Dist: pylance<0.40.0
+Provides-Extra: rest
+Requires-Dist: lance-namespace; extra == 'rest'
+Requires-Dist: lance-namespace-urllib3-client; extra == 'rest'

daft_lance-0.1.0/README.md

@@ -0,0 +1,63 @@
+# daft-lance
+
+Lance integration for [Daft](https://github.com/Eventual-Inc/Daft). Provides distributed compaction, scalar indexing, column merging, and REST catalog operations for Lance datasets.
+
+## Install
+
+```
+pip install daft-lance
+```
+
+For REST catalog support:
+
+```
+pip install daft-lance[rest]
+```
+
+## Usage
+
+### Compaction
+
+```python
+from daft_lance import compact_files
+
+compact_files("s3://bucket/my_dataset")
+```
+
+### Scalar Indexing
+
+```python
+from daft_lance import create_scalar_index
+
+create_scalar_index("s3://bucket/my_dataset", column="name", index_type="INVERTED")
+```
+
+### Column Merging
+
+```python
+from daft_lance import merge_columns_df
+
+merge_columns_df(df, "s3://bucket/my_dataset")
+```
+
+### REST Catalog
+
+```python
+from daft_lance import LanceRestConfig, write_lance_rest
+
+config = LanceRestConfig(base_url="https://api.lancedb.com", api_key="...")
+write_lance_rest(mp, config, namespace="default", table_name="my_table")
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/).
+
+```
+uv sync
+uv run pytest tests/ -v
+```
+
+## License
+
+Apache-2.0

daft_lance-0.1.0/daft_lance/__init__.py

@@ -0,0 +1,278 @@
+# ruff: noqa: I002
+# isort: dont-add-import: from __future__ import annotations
+import pathlib
+import warnings
+from typing import TYPE_CHECKING, Any, Optional, Union
+
+from daft import context
+from daft.daft import IOConfig
+from daft.io.object_store_options import io_config_to_storage_options
+
+from daft_lance.merge import merge_columns_from_df, merge_columns_internal
+from daft_lance.rest_config import LanceRestConfig
+from daft_lance.rest_write import create_lance_table_rest, register_lance_table_rest, write_lance_rest
+from daft_lance.utils import construct_lance_dataset
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from daft.dataframe import DataFrame
+    from daft.dependencies import pa
+
+    try:
+        from lance.dataset import LanceDataset
+        from lance.udf import BatchUDF
+    except ImportError:
+        BatchUDF = None
+        LanceDataset = None
+
+LanceDataset = Any
+
+
+def merge_columns(
+    uri: str | pathlib.Path,
+    io_config: IOConfig | None = None,
+    *,
+    transform: Union[dict[str, str], "BatchUDF", Callable[["pa.lib.RecordBatch"], "pa.lib.RecordBatch"]] = None,
+    read_columns: list[str] | None = None,
+    reader_schema: Optional["pa.Schema"] = None,
+    storage_options: dict[str, Any] | None = None,
+    daft_remote_args: dict[str, Any] | None = None,
+    concurrency: int | None = None,
+    version: int | str | None = None,
+    asof: str | None = None,
+    block_size: int | None = None,
+    commit_lock: Any | None = None,
+    index_cache_size: int | None = None,
+    default_scan_options: dict[str, Any] | None = None,
+    metadata_cache_size_bytes: int | None = None,
+) -> LanceDataset:
+    """Merge new columns into a LanceDB table using a transformation function."""
+    warnings.warn(
+        "merge_columns is deprecated and will be removed in a future release. "
+        "Please use merge_columns_df instead.",
+        category=DeprecationWarning,
+        stacklevel=2,
+    )
+
+    if transform is None:
+        raise ValueError(
+            "merge_columns requires a `transform` function; prefer using merge_columns_df with a prepared DataFrame if no transform is needed."
+        )
+
+    io_config = context.get_context().daft_planning_config.default_io_config if io_config is None else io_config
+    storage_options = storage_options or io_config_to_storage_options(io_config, uri)
+
+    lance_ds = construct_lance_dataset(
+        uri,
+        storage_options=storage_options,
+        version=version,
+        asof=asof,
+        block_size=block_size,
+        commit_lock=commit_lock,
+        index_cache_size=index_cache_size,
+        default_scan_options=default_scan_options,
+        metadata_cache_size_bytes=metadata_cache_size_bytes,
+    )
+
+    return merge_columns_internal(
+        lance_ds,
+        uri,
+        transform=transform,
+        read_columns=read_columns,
+        reader_schema=reader_schema,
+        storage_options=storage_options,
+        daft_remote_args=daft_remote_args,
+        concurrency=concurrency,
+    )
+
+
+def merge_columns_df(
+    df: "DataFrame",
+    uri: str | pathlib.Path,
+    io_config: IOConfig | None = None,
+    *,
+    read_columns: list[str] | None = None,
+    reader_schema: Optional["pa.Schema"] = None,
+    storage_options: dict[str, Any] | None = None,
+    daft_remote_args: dict[str, Any] | None = None,
+    concurrency: int | None = None,
+    version: int | str | None = None,
+    asof: str | None = None,
+    block_size: int | None = None,
+    commit_lock: Any | None = None,
+    index_cache_size: int | None = None,
+    default_scan_options: dict[str, Any] | None = None,
+    metadata_cache_size_bytes: int | None = None,
+    batch_size: int | None = None,
+    left_on: str | None = "_rowaddr",
+    right_on: str | None = "_rowaddr",
+) -> None:
+    """Row-level merge columns entrypoint using a DataFrame."""
+    io_config = context.get_context().daft_planning_config.default_io_config if io_config is None else io_config
+    storage_options = storage_options or io_config_to_storage_options(io_config, uri)
+
+    lance_ds = construct_lance_dataset(
+        uri,
+        storage_options=storage_options,
+        version=version,
+        asof=asof,
+        block_size=block_size,
+        commit_lock=commit_lock,
+        index_cache_size=index_cache_size,
+        default_scan_options=default_scan_options,
+        metadata_cache_size_bytes=metadata_cache_size_bytes,
+    )
+
+    effective_right_on = right_on or left_on
+    effective_batch_size = (
+        batch_size if batch_size is not None else daft_remote_args.get("batch_size", None) if daft_remote_args else None
+    )
+
+    return merge_columns_from_df(
+        df,
+        lance_ds=lance_ds,
+        uri=uri,
+        read_columns=read_columns,
+        reader_schema=reader_schema,
+        storage_options=storage_options,
+        daft_remote_args=daft_remote_args,
+        concurrency=concurrency,
+        left_on=left_on,
+        right_on=effective_right_on,
+        batch_size=effective_batch_size,
+    )
+
+
+def create_scalar_index(
+    uri: str | pathlib.Path,
+    io_config: IOConfig | None = None,
+    *,
+    column: str,
+    index_type: str = "INVERTED",
+    name: str | None = None,
+    replace: bool = True,
+    storage_options: dict[str, Any] | None = None,
+    version: int | str | None = None,
+    asof: str | None = None,
+    block_size: int | None = None,
+    commit_lock: Any | None = None,
+    index_cache_size: int | None = None,
+    default_scan_options: dict[str, Any] | None = None,
+    metadata_cache_size_bytes: int | None = None,
+    fragment_group_size: int | None = None,
+    num_partitions: int | None = None,
+    max_concurrency: int | None = None,
+    **kwargs: Any,
+) -> None:
+    """Build a distributed scalar index using Daft's distributed execution."""
+    try:
+        import lance
+        from packaging import version as packaging_version
+
+        from daft_lance.scalar_index import create_scalar_index_internal
+
+        lance_version = packaging_version.parse(lance.__version__)
+        min_required_version = packaging_version.parse("0.37.0")
+        if lance_version < min_required_version:
+            raise RuntimeError(
+                f"Distributed indexing requires pylance >= 0.37.0, but found {lance.__version__}. "
+                "The distributed indexing interfaces are not available in older versions. "
+                "Please upgrade lance by running: pip install --upgrade pylance"
+            )
+    except ImportError as e:
+        raise ImportError(
+            "Unable to import the `lance` package, please install: `pip install pylance`"
+        ) from e
+
+    io_config = context.get_context().daft_planning_config.default_io_config if io_config is None else io_config
+    storage_options = storage_options or io_config_to_storage_options(io_config, str(uri))
+
+    lance_ds = construct_lance_dataset(
+        uri,
+        storage_options=storage_options,
+        version=version,
+        asof=asof,
+        block_size=block_size,
+        commit_lock=commit_lock,
+        index_cache_size=index_cache_size,
+        default_scan_options=default_scan_options,
+        metadata_cache_size_bytes=metadata_cache_size_bytes,
+    )
+
+    create_scalar_index_internal(
+        lance_ds=lance_ds,
+        uri=uri,
+        column=column,
+        index_type=index_type,
+        name=name,
+        replace=replace,
+        storage_options=storage_options,
+        fragment_group_size=fragment_group_size,
+        num_partitions=num_partitions,
+        max_concurrency=max_concurrency,
+        **kwargs,
+    )
+
+
+def compact_files(
+    uri: str | pathlib.Path,
+    io_config: IOConfig | None = None,
+    *,
+    storage_options: dict[str, Any] | None = None,
+    version: int | str | None = None,
+    asof: str | None = None,
+    block_size: int | None = None,
+    commit_lock: Any | None = None,
+    index_cache_size: int | None = None,
+    default_scan_options: dict[str, Any] | None = None,
+    metadata_cache_size_bytes: int | None = None,
+    compaction_options: dict[str, Any] | None = None,
+    partition_num: int | None = None,
+    concurrency: int | None = None,
+) -> Any:
+    """Compact Lance dataset files using Daft UDF-style distributed execution."""
+    try:
+        import lance
+
+        from daft_lance.compaction import compact_files_internal
+    except ImportError as e:
+        raise ImportError(
+            "Unable to import the `lance` package, please install: `pip install pylance`"
+        ) from e
+
+    io_config = context.get_context().daft_planning_config.default_io_config if io_config is None else io_config
+    storage_options = storage_options or io_config_to_storage_options(
+        io_config, str(uri) if isinstance(uri, pathlib.Path) else uri
+    )
+
+    lance_ds = lance.dataset(
+        uri,
+        storage_options=storage_options,
+        version=version,
+        asof=asof,
+        block_size=block_size,
+        commit_lock=commit_lock,
+        index_cache_size=index_cache_size,
+        default_scan_options=default_scan_options,
+        metadata_cache_size_bytes=metadata_cache_size_bytes,
+    )
+
+    return compact_files_internal(
+        lance_ds=lance_ds,
+        compaction_options=compaction_options,
+        partition_num=partition_num,
+        concurrency=concurrency,
+    )
+
+
+__all__ = [
+    "LanceRestConfig",
+    "compact_files",
+    "create_lance_table_rest",
+    "create_scalar_index",
+    "merge_columns",
+    "merge_columns_df",
+    "register_lance_table_rest",
+    "write_lance_rest",
+]

daft_lance-0.1.0/daft_lance/compaction.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from lance.optimize import Compaction, CompactionMetrics, CompactionOptions, CompactionTask, RewriteResult
+
+if TYPE_CHECKING:
+    import lance
+import daft
+
+logger = logging.getLogger(__name__)
+
+
+class CompactionTaskUDF:
+    """UDF to execute a batch of Lance CompactionTasks on remote workers and return execution result dictionaries."""
+
+    def __init__(
+        self,
+        lance_ds: lance.LanceDataset,
+    ) -> None:
+        self.lance_ds = lance_ds
+
+    def __call__(self, task: CompactionTask) -> RewriteResult:
+        rewrite = task.execute(self.lance_ds)
+        return rewrite
+
+
+def compact_files_internal(
+    lance_ds: lance.LanceDataset,
+    *,
+    compaction_options: dict[str, Any] | None = None,
+    partition_num: int | None = None,
+    concurrency: int | None = None,
+) -> CompactionMetrics | None:
+    """Execute Lance file compaction in distributed environment using Daft UDF style."""
+    logger.info("Starting UDF-style distributed compaction")
+    plan = Compaction.plan(
+        lance_ds,
+        CompactionOptions(
+            **(compaction_options or {}),
+        ),
+    )
+    num_tasks = plan.num_tasks()
+    logger.info("Compaction plan created with %d tasks", num_tasks)
+
+    if num_tasks == 0:
+        logger.info("No compaction tasks needed")
+        return None
+
+    effective_partition_num = partition_num or 1
+    effective_partition_num = min(num_tasks, effective_partition_num)
+    assert effective_partition_num > 0
+    if effective_partition_num == 1:
+        df = daft.from_pydict({"task": plan.tasks})
+    else:
+        df = daft.from_pydict({"task": plan.tasks}).repartition(effective_partition_num)
+
+    WrappedRunner = daft.cls(
+        CompactionTaskUDF,
+        max_concurrency=concurrency,
+    )
+    df = df.select(WrappedRunner(lance_ds)(df["task"]).alias("rewrite"))
+    results = df.to_pandas()
+
+    metrics = Compaction.commit(lance_ds, results["rewrite"].to_list())
+    logger.info("Compaction completed successfully. Metrics: %s", metrics)
+    return metrics