mirror of
https://github.com/lancedb/lancedb.git
synced 2026-08-28 00:48:40 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 110e3024e3 |
+1
-8
@@ -1,5 +1,5 @@
|
|||||||
[tool.bumpversion]
|
[tool.bumpversion]
|
||||||
current_version = "0.37.1-beta.0"
|
current_version = "0.32.0-beta.2"
|
||||||
parse = """(?x)
|
parse = """(?x)
|
||||||
(?P<major>0|[1-9]\\d*)\\.
|
(?P<major>0|[1-9]\\d*)\\.
|
||||||
(?P<minor>0|[1-9]\\d*)\\.
|
(?P<minor>0|[1-9]\\d*)\\.
|
||||||
@@ -75,13 +75,6 @@ filename = "nodejs/Cargo.toml"
|
|||||||
replace = "\nversion = \"{new_version}\""
|
replace = "\nversion = \"{new_version}\""
|
||||||
search = "\nversion = \"{current_version}\""
|
search = "\nversion = \"{current_version}\""
|
||||||
|
|
||||||
# The Python package takes its version from here (pyproject.toml declares
|
|
||||||
# `dynamic = ["version"]`, so maturin reads it out of the crate manifest).
|
|
||||||
[[tool.bumpversion.files]]
|
|
||||||
filename = "python/Cargo.toml"
|
|
||||||
replace = "\nversion = \"{new_version}\""
|
|
||||||
search = "\nversion = \"{current_version}\""
|
|
||||||
|
|
||||||
# Java documentation
|
# Java documentation
|
||||||
[[tool.bumpversion.files]]
|
[[tool.bumpversion.files]]
|
||||||
filename = "docs/src/java/java.md"
|
filename = "docs/src/java/java.md"
|
||||||
|
|||||||
@@ -27,31 +27,19 @@ runs:
|
|||||||
# Extract failed job names
|
# Extract failed job names
|
||||||
FAILED_JOBS=$(echo "$JOB_RESULTS" | jq -r 'to_entries | map(select(.value.result == "failure")) | map(.key) | join(", ")')
|
FAILED_JOBS=$(echo "$JOB_RESULTS" | jq -r 'to_entries | map(select(.value.result == "failure")) | map(.key) | join(", ")')
|
||||||
|
|
||||||
TITLE="$WORKFLOW_NAME Failed ($FAILED_JOBS)"
|
# Create issue with workflow name, failed jobs, and run URL
|
||||||
|
gh issue create \
|
||||||
# This action now also runs on nightly schedules, so a breakage that
|
--title "$WORKFLOW_NAME Failed ($FAILED_JOBS)" \
|
||||||
# persists for a few days would otherwise file one issue per night.
|
--body "The workflow **$WORKFLOW_NAME** failed during execution.
|
||||||
# Comment on the open report instead when one already exists.
|
|
||||||
EXISTING=$(gh issue list --state open --label ci --limit 100 --json number,title \
|
|
||||||
| jq -r --arg title "$TITLE" 'map(select(.title == $title)) | .[0].number // empty')
|
|
||||||
|
|
||||||
if [ -n "$EXISTING" ]; then
|
|
||||||
gh issue comment "$EXISTING" --body "Failed again: $RUN_URL"
|
|
||||||
echo "Commented on existing issue #$EXISTING"
|
|
||||||
else
|
|
||||||
gh issue create \
|
|
||||||
--title "$TITLE" \
|
|
||||||
--body "The workflow **$WORKFLOW_NAME** failed during execution.
|
|
||||||
|
|
||||||
**Failed jobs:** $FAILED_JOBS
|
**Failed jobs:** $FAILED_JOBS
|
||||||
|
|
||||||
**Run URL:** $RUN_URL
|
**Run URL:** $RUN_URL
|
||||||
|
|
||||||
Please investigate the failed jobs and address any issues." \
|
Please investigate the failed jobs and address any issues." \
|
||||||
--label "ci"
|
--label "ci"
|
||||||
|
|
||||||
echo "Issue created successfully"
|
echo "Issue created successfully"
|
||||||
fi
|
|
||||||
else
|
else
|
||||||
echo "No job failures detected, skipping issue creation"
|
echo "No job failures detected, skipping issue creation"
|
||||||
fi
|
fi
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ on:
|
|||||||
# We don't publish pre-releases for Rust. Crates.io is just a source
|
# We don't publish pre-releases for Rust. Crates.io is just a source
|
||||||
# distribution, so we don't need to publish pre-releases.
|
# distribution, so we don't need to publish pre-releases.
|
||||||
- "v*-beta*"
|
- "v*-beta*"
|
||||||
|
- "*-v*" # for example, python-vX.Y.Z
|
||||||
|
|
||||||
env:
|
env:
|
||||||
# This env var is used by Swatinem/rust-cache@v2 for the cache
|
# This env var is used by Swatinem/rust-cache@v2 for the cache
|
||||||
|
|||||||
@@ -1,85 +0,0 @@
|
|||||||
name: GitHub Release
|
|
||||||
|
|
||||||
# All SDKs share one version, so a single `vX.Y.Z` tag produces a single GitHub
|
|
||||||
# release covering all of them. The per-package publish workflows (PyPI, NPM,
|
|
||||||
# Cargo, Maven) trigger off the same tag independently.
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "v*"
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
gh-release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
lfs: true
|
|
||||||
- name: Extract version
|
|
||||||
id: extract_version
|
|
||||||
env:
|
|
||||||
GITHUB_REF: ${{ github.ref }}
|
|
||||||
run: |
|
|
||||||
set -e
|
|
||||||
echo "Extracting tag and version from $GITHUB_REF"
|
|
||||||
if [[ $GITHUB_REF =~ refs/tags/v(.*) ]]; then
|
|
||||||
VERSION=${BASH_REMATCH[1]}
|
|
||||||
TAG=v$VERSION
|
|
||||||
echo "tag=$TAG" >> $GITHUB_OUTPUT
|
|
||||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
|
||||||
else
|
|
||||||
echo "Failed to extract version from $GITHUB_REF"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "Extracted version $VERSION from $GITHUB_REF"
|
|
||||||
if [[ $VERSION =~ beta ]]; then
|
|
||||||
echo "This is a beta release"
|
|
||||||
echo "prerelease=true" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
# Get last release (that is not this one)
|
|
||||||
FROM_TAG=$(git tag --sort='version:refname' \
|
|
||||||
| grep ^v \
|
|
||||||
| grep -vF "$TAG" \
|
|
||||||
| python ci/semver_sort.py v \
|
|
||||||
| tail -n 1)
|
|
||||||
else
|
|
||||||
echo "This is a stable release"
|
|
||||||
echo "prerelease=false" >> $GITHUB_OUTPUT
|
|
||||||
# Get last stable tag (ignore betas)
|
|
||||||
FROM_TAG=$(git tag --sort='version:refname' \
|
|
||||||
| grep ^v \
|
|
||||||
| grep -vF "$TAG" \
|
|
||||||
| grep -v beta \
|
|
||||||
| python ci/semver_sort.py v \
|
|
||||||
| tail -n 1)
|
|
||||||
fi
|
|
||||||
echo "Found from tag $FROM_TAG"
|
|
||||||
echo "from_tag=$FROM_TAG" >> $GITHUB_OUTPUT
|
|
||||||
- name: Create Release Notes
|
|
||||||
id: release_notes
|
|
||||||
uses: mikepenz/release-changelog-builder-action@v4
|
|
||||||
with:
|
|
||||||
configuration: .github/release_notes.json
|
|
||||||
toTag: ${{ steps.extract_version.outputs.tag }}
|
|
||||||
fromTag: ${{ steps.extract_version.outputs.from_tag }}
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Create GH release
|
|
||||||
uses: softprops/action-gh-release@v2
|
|
||||||
with:
|
|
||||||
# Marking betas as pre-releases keeps them from taking the "Latest"
|
|
||||||
# badge on the releases page.
|
|
||||||
prerelease: ${{ steps.extract_version.outputs.prerelease }}
|
|
||||||
make_latest: ${{ steps.extract_version.outputs.prerelease == 'false' }}
|
|
||||||
tag_name: ${{ steps.extract_version.outputs.tag }}
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
generate_release_notes: false
|
|
||||||
name: LanceDB v${{ steps.extract_version.outputs.version }}
|
|
||||||
body: ${{ steps.release_notes.outputs.changelog }}
|
|
||||||
@@ -1,14 +1,13 @@
|
|||||||
name: Create release commit
|
name: Create release commit
|
||||||
|
|
||||||
# This workflow increments the version, tags it, and pushes it. All SDKs share
|
# This workflow increments versions, tags the version, and pushes it.
|
||||||
# a single version, so one tag releases all of them.
|
|
||||||
# When a tag is pushed, another workflow is triggered that creates a GH release
|
# When a tag is pushed, another workflow is triggered that creates a GH release
|
||||||
# and uploads the binaries. This workflow is only for creating the tag.
|
# and uploads the binaries. This workflow is only for creating the tag.
|
||||||
|
|
||||||
# This script will enforce that a minor version is incremented if there are any
|
# This script will enforce that a minor version is incremented if there are any
|
||||||
# breaking changes since the last minor increment. A breaking change in any SDK
|
# breaking changes since the last minor increment. However, it isn't able to
|
||||||
# bumps the minor version for all of them. If you wish to bypass this check, you
|
# differentiate between breaking changes in Node versus Python. If you wish to
|
||||||
# can manually increment the version and push the tag.
|
# bypass this check, you can manually increment the version and push the tag.
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -25,6 +24,16 @@ on:
|
|||||||
options:
|
options:
|
||||||
- preview
|
- preview
|
||||||
- stable
|
- stable
|
||||||
|
python:
|
||||||
|
description: 'Make a Python release'
|
||||||
|
required: true
|
||||||
|
default: true
|
||||||
|
type: boolean
|
||||||
|
other:
|
||||||
|
description: 'Make a Node/Rust/Java release'
|
||||||
|
required: true
|
||||||
|
default: true
|
||||||
|
type: boolean
|
||||||
bump-minor:
|
bump-minor:
|
||||||
description: 'Bump minor version'
|
description: 'Bump minor version'
|
||||||
required: true
|
required: true
|
||||||
@@ -56,12 +65,25 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
git config user.name 'Lance Release'
|
git config user.name 'Lance Release'
|
||||||
git config user.email 'lance-dev@lancedb.com'
|
git config user.email 'lance-dev@lancedb.com'
|
||||||
- name: Bump version
|
- name: Bump Python version
|
||||||
|
if: ${{ inputs.python }}
|
||||||
|
working-directory: python
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run: |
|
||||||
|
# Need to get the commit before bumping the version, so we can
|
||||||
|
# determine if there are breaking changes in the next step as well.
|
||||||
|
echo "COMMIT_BEFORE_BUMP=$(git rev-parse HEAD)" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
pip install bump-my-version PyGithub packaging
|
||||||
|
bash ../ci/bump_version.sh ${{ inputs.type }} ${{ inputs.bump-minor }} python-v
|
||||||
|
- name: Bump Node/Rust version
|
||||||
|
if: ${{ inputs.other }}
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
pip install bump-my-version PyGithub packaging
|
pip install bump-my-version PyGithub packaging
|
||||||
bash ci/bump_version.sh ${{ inputs.type }} ${{ inputs.bump-minor }}
|
bash ci/bump_version.sh ${{ inputs.type }} ${{ inputs.bump-minor }} v $COMMIT_BEFORE_BUMP
|
||||||
bash ci/update_lockfiles.sh --amend
|
bash ci/update_lockfiles.sh --amend
|
||||||
- name: Push new version tag
|
- name: Push new version tag
|
||||||
if: ${{ !inputs.dry_run }}
|
if: ${{ !inputs.dry_run }}
|
||||||
|
|||||||
@@ -61,11 +61,6 @@ jobs:
|
|||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt install -y protobuf-compiler libssl-dev
|
sudo apt install -y protobuf-compiler libssl-dev
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Format Rust
|
- name: Format Rust
|
||||||
run: cargo fmt --all -- --check
|
run: cargo fmt --all -- --check
|
||||||
- name: Lint Rust
|
- name: Lint Rust
|
||||||
@@ -108,11 +103,6 @@ jobs:
|
|||||||
cache: 'pnpm'
|
cache: 'pnpm'
|
||||||
cache-dependency-path: nodejs/pnpm-lock.yaml
|
cache-dependency-path: nodejs/pnpm-lock.yaml
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
@@ -192,11 +182,6 @@ jobs:
|
|||||||
cache-dependency-path: nodejs/pnpm-lock.yaml
|
cache-dependency-path: nodejs/pnpm-lock.yaml
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
brew install protobuf
|
brew install protobuf
|
||||||
|
|||||||
@@ -10,16 +10,10 @@ permissions:
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
tags:
|
tags:
|
||||||
- "v*"
|
- "v*"
|
||||||
# The cross-compiled targets (musl especially) break from toolchain and
|
|
||||||
# dependency changes that nothing else in CI catches, and discovering that
|
|
||||||
# mid-release is expensive. A nightly run keeps that signal while dropping
|
|
||||||
# the full 8-target release matrix from all ~90 pushes to main each month.
|
|
||||||
# `report-failure` files an issue when a nightly breaks.
|
|
||||||
schedule:
|
|
||||||
- cron: "0 8 * * *"
|
|
||||||
workflow_dispatch:
|
|
||||||
pull_request:
|
pull_request:
|
||||||
# This should trigger a dry run (we skip the final publish step)
|
# This should trigger a dry run (we skip the final publish step)
|
||||||
paths:
|
paths:
|
||||||
@@ -32,6 +26,73 @@ concurrency:
|
|||||||
cancel-in-progress: true
|
cancel-in-progress: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
gh-release:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
lfs: true
|
||||||
|
- name: Extract version
|
||||||
|
id: extract_version
|
||||||
|
env:
|
||||||
|
GITHUB_REF: ${{ github.ref }}
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
echo "Extracting tag and version from $GITHUB_REF"
|
||||||
|
if [[ $GITHUB_REF =~ refs/tags/v(.*) ]]; then
|
||||||
|
VERSION=${BASH_REMATCH[1]}
|
||||||
|
TAG=v$VERSION
|
||||||
|
echo "tag=$TAG" >> $GITHUB_OUTPUT
|
||||||
|
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "Failed to extract version from $GITHUB_REF"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "Extracted version $VERSION from $GITHUB_REF"
|
||||||
|
if [[ $VERSION =~ beta ]]; then
|
||||||
|
echo "This is a beta release"
|
||||||
|
|
||||||
|
# Get last release (that is not this one)
|
||||||
|
FROM_TAG=$(git tag --sort='version:refname' \
|
||||||
|
| grep ^v \
|
||||||
|
| grep -vF "$TAG" \
|
||||||
|
| python ci/semver_sort.py v \
|
||||||
|
| tail -n 1)
|
||||||
|
else
|
||||||
|
echo "This is a stable release"
|
||||||
|
# Get last stable tag (ignore betas)
|
||||||
|
FROM_TAG=$(git tag --sort='version:refname' \
|
||||||
|
| grep ^v \
|
||||||
|
| grep -vF "$TAG" \
|
||||||
|
| grep -v beta \
|
||||||
|
| python ci/semver_sort.py v \
|
||||||
|
| tail -n 1)
|
||||||
|
fi
|
||||||
|
echo "Found from tag $FROM_TAG"
|
||||||
|
echo "from_tag=$FROM_TAG" >> $GITHUB_OUTPUT
|
||||||
|
- name: Create Release Notes
|
||||||
|
id: release_notes
|
||||||
|
uses: mikepenz/release-changelog-builder-action@v4
|
||||||
|
with:
|
||||||
|
configuration: .github/release_notes.json
|
||||||
|
toTag: ${{ steps.extract_version.outputs.tag }}
|
||||||
|
fromTag: ${{ steps.extract_version.outputs.from_tag }}
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- name: Create GH release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
prerelease: ${{ contains('beta', github.ref) }}
|
||||||
|
tag_name: ${{ steps.extract_version.outputs.tag }}
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
generate_release_notes: false
|
||||||
|
name: Node/Rust LanceDB v${{ steps.extract_version.outputs.version }}
|
||||||
|
body: ${{ steps.release_notes.outputs.changelog }}
|
||||||
|
|
||||||
build-lancedb:
|
build-lancedb:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
@@ -40,18 +101,9 @@ jobs:
|
|||||||
- target: aarch64-apple-darwin
|
- target: aarch64-apple-darwin
|
||||||
host: macos-latest
|
host: macos-latest
|
||||||
features: fp16kernels
|
features: fp16kernels
|
||||||
pre_build: |-
|
pre_build: brew install protobuf
|
||||||
brew install protobuf
|
|
||||||
# Fat LTO (the workspace default in .cargo/config.toml) is
|
|
||||||
# single-threaded and is the peak-memory step of the build. On
|
|
||||||
# this runner it accounted for ~111 of the job's ~113 minutes,
|
|
||||||
# making it the critical path of the entire publish pipeline.
|
|
||||||
# ThinLTO parallelizes it across the runner's cores, for a few
|
|
||||||
# percent of runtime performance.
|
|
||||||
export CARGO_PROFILE_RELEASE_LTO=thin
|
|
||||||
export CARGO_PROFILE_RELEASE_CODEGEN_UNITS=16
|
|
||||||
- target: x86_64-pc-windows-msvc
|
- target: x86_64-pc-windows-msvc
|
||||||
host: windows-2025
|
host: windows-2025-8x-x64
|
||||||
features: ","
|
features: ","
|
||||||
pre_build: |-
|
pre_build: |-
|
||||||
choco install --no-progress protoc ninja nasm
|
choco install --no-progress protoc ninja nasm
|
||||||
@@ -59,19 +111,19 @@ jobs:
|
|||||||
# There is an issue where choco doesn't add nasm to the path
|
# There is an issue where choco doesn't add nasm to the path
|
||||||
export PATH="$PATH:/c/Program Files/NASM"
|
export PATH="$PATH:/c/Program Files/NASM"
|
||||||
nasm -v
|
nasm -v
|
||||||
# See the ThinLTO note on aarch64-apple-darwin above. Keeping
|
# Fat LTO of the cdylib is single-threaded and the peak-memory
|
||||||
# peak memory down is also what lets this run on the standard
|
# step of the build, and had started hitting rustc-LLVM OOM on the
|
||||||
# 4-core runner: the 8-core larger runner was only needed to
|
# Windows runners. ThinLTO parallelizes it across the runner's
|
||||||
# stop fat LTO from OOMing rustc-LLVM.
|
# cores and keeps peak memory well under the limit.
|
||||||
export CARGO_PROFILE_RELEASE_LTO=thin
|
export CARGO_PROFILE_RELEASE_LTO=thin
|
||||||
export CARGO_PROFILE_RELEASE_CODEGEN_UNITS=16
|
export CARGO_PROFILE_RELEASE_CODEGEN_UNITS=16
|
||||||
- target: aarch64-pc-windows-msvc
|
- target: aarch64-pc-windows-msvc
|
||||||
host: windows-2025
|
host: windows-2025-8x-x64
|
||||||
features: ","
|
features: ","
|
||||||
pre_build: |-
|
pre_build: |-
|
||||||
choco install --no-progress protoc
|
choco install --no-progress protoc
|
||||||
rustup target add aarch64-pc-windows-msvc
|
rustup target add aarch64-pc-windows-msvc
|
||||||
# See the ThinLTO note on aarch64-apple-darwin above.
|
# See ThinLTO note on the x86_64-pc-windows-msvc target above.
|
||||||
export CARGO_PROFILE_RELEASE_LTO=thin
|
export CARGO_PROFILE_RELEASE_LTO=thin
|
||||||
export CARGO_PROFILE_RELEASE_CODEGEN_UNITS=16
|
export CARGO_PROFILE_RELEASE_CODEGEN_UNITS=16
|
||||||
- target: x86_64-unknown-linux-gnu
|
- target: x86_64-unknown-linux-gnu
|
||||||
@@ -146,49 +198,16 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: stable
|
||||||
targets: ${{ matrix.settings.target }}
|
targets: ${{ matrix.settings.target }}
|
||||||
# These builds were entirely uncached: the old key was static, so
|
- name: Cache cargo
|
||||||
# `actions/cache` (which only writes on a miss) could never refresh it,
|
uses: actions/cache@v5
|
||||||
# and the multi-GB whole-`target/` copy it tried to store never fit the
|
|
||||||
# repo's cache budget, so no entry was ever saved. rust-cache prunes
|
|
||||||
# `target/` to dependency artifacts and keys on Cargo.lock plus the rustc
|
|
||||||
# version, which both fixes the key and keeps entries a sane size.
|
|
||||||
#
|
|
||||||
# This caches dependency *compilation* only. The LTO link of the cdylib
|
|
||||||
# re-runs regardless, since the local crate changes every time, so the
|
|
||||||
# win is larger on the non-LTO jobs than here.
|
|
||||||
- name: Cache cargo (native builds)
|
|
||||||
uses: Swatinem/rust-cache@v2
|
|
||||||
if: ${{ !matrix.settings.docker }}
|
|
||||||
with:
|
with:
|
||||||
# The release profile and per-target dirs differ from what the test
|
path: |
|
||||||
# workflows cache, so these need to be separate entries.
|
~/.cargo/registry/index/
|
||||||
key: release-${{ matrix.settings.target }}
|
~/.cargo/registry/cache/
|
||||||
# Only the nightly run on main writes, so tag and PR runs restore a
|
~/.cargo/git/db/
|
||||||
# warm entry without every dependabot PR writing its own (which would
|
.cargo-cache
|
||||||
# be unreadable elsewhere anyway, since GitHub scopes caches to the
|
target/
|
||||||
# creating ref). The nightly cadence also keeps entries inside
|
key: nodejs-${{ matrix.settings.target }}-cargo-${{ matrix.settings.host }}
|
||||||
# GitHub's 7-day eviction window, which a tag-only trigger would not.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
# Docker builds can use rust-cache too. `target/` already lives on the
|
|
||||||
# host because the whole workspace is bind-mounted into the container, and
|
|
||||||
# rust-cache's prune and save run host-side, so they can manage it -- which
|
|
||||||
# is what keeps the entry to dependency artifacts rather than a multi-GB
|
|
||||||
# copy of everything.
|
|
||||||
#
|
|
||||||
# Two differences from the native builds. The container's CARGO_HOME is
|
|
||||||
# bind-mounted from `.cargo-cache` rather than the host's ~/.cargo, so that
|
|
||||||
# has to be cached explicitly. And the key is derived from the *host* rustc
|
|
||||||
# version, which is not the compiler that produced these artifacts; that is
|
|
||||||
# safe because cargo fingerprints the real compiler and rebuilds on a
|
|
||||||
# mismatch, it just means a base-image toolchain bump costs one cold build
|
|
||||||
# instead of invalidating the key.
|
|
||||||
- name: Cache cargo (docker builds)
|
|
||||||
uses: Swatinem/rust-cache@v2
|
|
||||||
if: ${{ matrix.settings.docker }}
|
|
||||||
with:
|
|
||||||
key: docker-${{ matrix.settings.target }}
|
|
||||||
cache-directories: .cargo-cache
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install --frozen-lockfile
|
run: pnpm install --frozen-lockfile
|
||||||
- name: Install Zig
|
- name: Install Zig
|
||||||
@@ -206,13 +225,9 @@ jobs:
|
|||||||
if: ${{ matrix.settings.docker }}
|
if: ${{ matrix.settings.docker }}
|
||||||
with:
|
with:
|
||||||
image: ${{ matrix.settings.docker }}
|
image: ${{ matrix.settings.docker }}
|
||||||
# All three mounts must live under `.cargo-cache`, which is what the
|
|
||||||
# cache step above saves. Previously the registry mounts pointed at
|
|
||||||
# `.cargo/...`, a path nothing cached, so the container re-downloaded
|
|
||||||
# the whole crate registry on every run.
|
|
||||||
options: "--user 0:0 -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db \
|
options: "--user 0:0 -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db \
|
||||||
-v ${{ github.workspace }}/.cargo-cache/registry/cache:/usr/local/cargo/registry/cache \
|
-v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache \
|
||||||
-v ${{ github.workspace }}/.cargo-cache/registry/index:/usr/local/cargo/registry/index \
|
-v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index \
|
||||||
-v ${{ github.workspace }}:/build -w /build/nodejs"
|
-v ${{ github.workspace }}:/build -w /build/nodejs"
|
||||||
run: |
|
run: |
|
||||||
set -e
|
set -e
|
||||||
@@ -224,16 +239,6 @@ jobs:
|
|||||||
--js ../lancedb/native.js \
|
--js ../lancedb/native.js \
|
||||||
--strip \
|
--strip \
|
||||||
--output-dir dist/
|
--output-dir dist/
|
||||||
# The container runs as root (`--user 0:0`), so everything it wrote to the
|
|
||||||
# mounted cache dirs is root-owned. rust-cache's post step runs as the
|
|
||||||
# runner user and has to both read these and delete from them while
|
|
||||||
# pruning, so hand them back before it runs.
|
|
||||||
- name: Take ownership of docker build output
|
|
||||||
if: ${{ matrix.settings.docker }}
|
|
||||||
run: |
|
|
||||||
sudo chown -R "$(id -u):$(id -g)" \
|
|
||||||
"${{ github.workspace }}/.cargo-cache" \
|
|
||||||
"${{ github.workspace }}/target"
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: |
|
run: |
|
||||||
${{ matrix.settings.pre_build }}
|
${{ matrix.settings.pre_build }}
|
||||||
@@ -247,15 +252,6 @@ jobs:
|
|||||||
--output-dir dist/
|
--output-dir dist/
|
||||||
if: ${{ !matrix.settings.docker }}
|
if: ${{ !matrix.settings.docker }}
|
||||||
shell: bash
|
shell: bash
|
||||||
# The standard Windows runners have ~14 GB free, and a release `target/`
|
|
||||||
# for this workspace is a large fraction of that. Report the remaining
|
|
||||||
# headroom so a build that only just fits is visible before a dependency
|
|
||||||
# bump turns it into a failed release. `always()` so the numbers are
|
|
||||||
# still there when the build is what ran out of space.
|
|
||||||
- name: Report disk headroom
|
|
||||||
if: always()
|
|
||||||
run: df -h
|
|
||||||
shell: bash
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-artifact@v7
|
uses: actions/upload-artifact@v7
|
||||||
with:
|
with:
|
||||||
@@ -406,9 +402,7 @@ jobs:
|
|||||||
name: Report Workflow Failure
|
name: Report Workflow Failure
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [build-lancedb, test-lancedb, publish]
|
needs: [build-lancedb, test-lancedb, publish]
|
||||||
# Nightly runs are the only thing watching the cross-compiled targets now,
|
if: always() && failure() && startsWith(github.ref, 'refs/tags/v')
|
||||||
# so they have to report failures too or the signal is silently lost.
|
|
||||||
if: always() && failure() && (startsWith(github.ref, 'refs/tags/v') || github.event_name == 'schedule')
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
issues: write
|
issues: write
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ name: PyPI Publish
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- 'v*'
|
- 'python-v*'
|
||||||
pull_request:
|
pull_request:
|
||||||
# This should trigger a dry run (we skip the final publish step)
|
# This should trigger a dry run (we skip the final publish step)
|
||||||
paths:
|
paths:
|
||||||
@@ -20,12 +20,6 @@ env:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
|
|
||||||
# Without this, a force-push to a PR leaves the previous run going -- including
|
|
||||||
# a ~74 minute Windows job and a billed arm64 wheel build.
|
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
linux:
|
linux:
|
||||||
name: Python ${{ matrix.config.package_name }} ${{ matrix.config.platform }} manylinux${{ matrix.config.manylinux }}
|
name: Python ${{ matrix.config.package_name }} ${{ matrix.config.platform }} manylinux${{ matrix.config.manylinux }}
|
||||||
@@ -78,7 +72,7 @@ jobs:
|
|||||||
package-name: ${{ matrix.config.package_name }}
|
package-name: ${{ matrix.config.package_name }}
|
||||||
rustflags: ${{ matrix.config.rustflags }}
|
rustflags: ${{ matrix.config.rustflags }}
|
||||||
- uses: actions/upload-artifact@v7
|
- uses: actions/upload-artifact@v7
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
if: startsWith(github.ref, 'refs/tags/python-v')
|
||||||
with:
|
with:
|
||||||
name: wheels-linux-${{ matrix.config.package_name }}-${{ matrix.config.platform }}-${{ matrix.config.manylinux }}
|
name: wheels-linux-${{ matrix.config.package_name }}-${{ matrix.config.platform }}-${{ matrix.config.manylinux }}
|
||||||
path: target/wheels/*.whl
|
path: target/wheels/*.whl
|
||||||
@@ -107,7 +101,7 @@ jobs:
|
|||||||
python-minor-version: 10
|
python-minor-version: 10
|
||||||
args: "--release --strip --target ${{ matrix.config.target }} --features fp16kernels"
|
args: "--release --strip --target ${{ matrix.config.target }} --features fp16kernels"
|
||||||
- uses: actions/upload-artifact@v7
|
- uses: actions/upload-artifact@v7
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
if: startsWith(github.ref, 'refs/tags/python-v')
|
||||||
with:
|
with:
|
||||||
name: wheels-mac-${{ matrix.config.target }}
|
name: wheels-mac-${{ matrix.config.target }}
|
||||||
path: target/wheels/lancedb-*.whl
|
path: target/wheels/lancedb-*.whl
|
||||||
@@ -128,26 +122,19 @@ jobs:
|
|||||||
uses: actions/setup-python@v6
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: "3.13"
|
python-version: "3.13"
|
||||||
# NOTE: caching cargo here would be a no-op. This workflow only runs on
|
|
||||||
# tags and PRs, and GitHub only lets a run restore caches from its own ref
|
|
||||||
# or the default branch -- so with no run on main there is nothing that
|
|
||||||
# can populate an entry the release build would be allowed to read. Fixing
|
|
||||||
# this needs a main/nightly trigger (which would also catch wheel-build
|
|
||||||
# breakage before a release); the ~74 minutes here is otherwise dominated
|
|
||||||
# by the fat-LTO link, which no cache avoids.
|
|
||||||
- uses: ./.github/workflows/build_windows_wheel
|
- uses: ./.github/workflows/build_windows_wheel
|
||||||
with:
|
with:
|
||||||
python-minor-version: 10
|
python-minor-version: 10
|
||||||
args: "--release --strip"
|
args: "--release --strip"
|
||||||
- uses: actions/upload-artifact@v7
|
- uses: actions/upload-artifact@v7
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
if: startsWith(github.ref, 'refs/tags/python-v')
|
||||||
with:
|
with:
|
||||||
name: wheels-windows
|
name: wheels-windows
|
||||||
path: target/wheels/lancedb-*.whl
|
path: target/wheels/lancedb-*.whl
|
||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
publish:
|
publish:
|
||||||
name: Publish wheels
|
name: Publish wheels
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
if: startsWith(github.ref, 'refs/tags/python-v')
|
||||||
needs: [linux, mac, windows]
|
needs: [linux, mac, windows]
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
@@ -196,6 +183,72 @@ jobs:
|
|||||||
uses: pypa/gh-action-pypi-publish@release/v1
|
uses: pypa/gh-action-pypi-publish@release/v1
|
||||||
with:
|
with:
|
||||||
packages-dir: target/wheels/
|
packages-dir: target/wheels/
|
||||||
|
gh-release:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/python-v')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
lfs: true
|
||||||
|
- name: Extract version
|
||||||
|
id: extract_version
|
||||||
|
env:
|
||||||
|
GITHUB_REF: ${{ github.ref }}
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
echo "Extracting tag and version from $GITHUB_REF"
|
||||||
|
if [[ $GITHUB_REF =~ refs/tags/python-v(.*) ]]; then
|
||||||
|
VERSION=${BASH_REMATCH[1]}
|
||||||
|
TAG=python-v$VERSION
|
||||||
|
echo "tag=$TAG" >> $GITHUB_OUTPUT
|
||||||
|
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "Failed to extract version from $GITHUB_REF"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "Extracted version $VERSION from $GITHUB_REF"
|
||||||
|
if [[ $VERSION =~ beta ]]; then
|
||||||
|
echo "This is a beta release"
|
||||||
|
|
||||||
|
# Get last release (that is not this one)
|
||||||
|
FROM_TAG=$(git tag --sort='version:refname' \
|
||||||
|
| grep ^python-v \
|
||||||
|
| grep -vF "$TAG" \
|
||||||
|
| python ci/semver_sort.py python-v \
|
||||||
|
| tail -n 1)
|
||||||
|
else
|
||||||
|
echo "This is a stable release"
|
||||||
|
# Get last stable tag (ignore betas)
|
||||||
|
FROM_TAG=$(git tag --sort='version:refname' \
|
||||||
|
| grep ^python-v \
|
||||||
|
| grep -vF "$TAG" \
|
||||||
|
| grep -v beta \
|
||||||
|
| python ci/semver_sort.py python-v \
|
||||||
|
| tail -n 1)
|
||||||
|
fi
|
||||||
|
echo "Found from tag $FROM_TAG"
|
||||||
|
echo "from_tag=$FROM_TAG" >> $GITHUB_OUTPUT
|
||||||
|
- name: Create Python Release Notes
|
||||||
|
id: python_release_notes
|
||||||
|
uses: mikepenz/release-changelog-builder-action@v4
|
||||||
|
with:
|
||||||
|
configuration: .github/release_notes.json
|
||||||
|
toTag: ${{ steps.extract_version.outputs.tag }}
|
||||||
|
fromTag: ${{ steps.extract_version.outputs.from_tag }}
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- name: Create Python GH release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
prerelease: ${{ contains('beta', github.ref) }}
|
||||||
|
tag_name: ${{ steps.extract_version.outputs.tag }}
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
generate_release_notes: false
|
||||||
|
name: Python LanceDB v${{ steps.extract_version.outputs.version }}
|
||||||
|
body: ${{ steps.python_release_notes.outputs.changelog }}
|
||||||
report-failure:
|
report-failure:
|
||||||
name: Report Workflow Failure
|
name: Report Workflow Failure
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -203,7 +256,7 @@ jobs:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
issues: write
|
issues: write
|
||||||
if: always() && failure() && startsWith(github.ref, 'refs/tags/v')
|
if: always() && failure() && startsWith(github.ref, 'refs/tags/python-v')
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
- uses: ./.github/actions/create-failure-issue
|
- uses: ./.github/actions/create-failure-issue
|
||||||
|
|||||||
@@ -108,15 +108,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt install -y protobuf-compiler
|
sudo apt install -y protobuf-compiler
|
||||||
# `pip install -e .` builds the extension with maturin, which is most of
|
|
||||||
# this job's ~33 minutes. It had no Rust cache, so every dependency was
|
|
||||||
# recompiled from scratch on every run.
|
|
||||||
- uses: Swatinem/rust-cache@v2
|
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install
|
- name: Install
|
||||||
run: |
|
run: |
|
||||||
pip install --extra-index-url https://pypi.fury.io/lance-format/ --extra-index-url https://pypi.fury.io/lancedb/ -e .[tests,dev,embeddings]
|
pip install --extra-index-url https://pypi.fury.io/lance-format/ --extra-index-url https://pypi.fury.io/lancedb/ -e .[tests,dev,embeddings]
|
||||||
@@ -177,14 +168,6 @@ jobs:
|
|||||||
uses: actions/setup-python@v6
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: "3.13"
|
python-version: "3.13"
|
||||||
# maturin runs cargo natively on macOS (docker is Linux-only), so the host
|
|
||||||
# target dir is cacheable. This job had no Rust cache.
|
|
||||||
- uses: Swatinem/rust-cache@v2
|
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- uses: ./.github/workflows/build_mac_wheel
|
- uses: ./.github/workflows/build_mac_wheel
|
||||||
with:
|
with:
|
||||||
args: --profile ci
|
args: --profile ci
|
||||||
@@ -214,14 +197,6 @@ jobs:
|
|||||||
uses: actions/setup-python@v6
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: "3.13"
|
python-version: "3.13"
|
||||||
# maturin runs cargo natively on Windows (docker is Linux-only), so the
|
|
||||||
# host target dir is cacheable. This job had no Rust cache at all and so
|
|
||||||
# rebuilt every dependency from scratch on every run.
|
|
||||||
- uses: Swatinem/rust-cache@v2
|
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. The repo sits at
|
|
||||||
# GitHub's cache cap, so per-PR saves just evict main's entries.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- uses: ./.github/workflows/build_windows_wheel
|
- uses: ./.github/workflows/build_windows_wheel
|
||||||
with:
|
with:
|
||||||
args: --profile ci
|
args: --profile ci
|
||||||
@@ -249,14 +224,6 @@ jobs:
|
|||||||
uses: actions/setup-python@v6
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: "3.10"
|
python-version: "3.10"
|
||||||
# As with Doctest, `pip install -e .` compiles the extension and this job
|
|
||||||
# had no Rust cache, which is most of its ~37 minutes.
|
|
||||||
- uses: Swatinem/rust-cache@v2
|
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install lancedb
|
- name: Install lancedb
|
||||||
run: |
|
run: |
|
||||||
pip install "pydantic<2"
|
pip install "pydantic<2"
|
||||||
|
|||||||
@@ -48,11 +48,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
@@ -94,11 +89,6 @@ jobs:
|
|||||||
run: rm -f Cargo.lock
|
run: rm -f Cargo.lock
|
||||||
- uses: rui314/setup-mold@v1
|
- uses: rui314/setup-mold@v1
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
@@ -128,11 +118,6 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
@@ -190,11 +175,6 @@ jobs:
|
|||||||
- name: CPU features
|
- name: CPU features
|
||||||
run: sysctl -a | grep cpu
|
run: sysctl -a | grep cpu
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: brew install protobuf
|
run: brew install protobuf
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
@@ -207,19 +187,12 @@ jobs:
|
|||||||
cargo test --profile ci --features $ALL_FEATURES --locked
|
cargo test --profile ci --features $ALL_FEATURES --locked
|
||||||
|
|
||||||
windows:
|
windows:
|
||||||
|
runs-on: windows-2022
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
target:
|
||||||
- target: x86_64-pc-windows-msvc
|
- x86_64-pc-windows-msvc
|
||||||
runner: windows-2022
|
- aarch64-pc-windows-msvc
|
||||||
# windows-11-arm is a standard runner, so it is free on public repos.
|
|
||||||
# Running natively lets the aarch64 tests actually execute -- this
|
|
||||||
# job used to cross-compile them and then skip the test step, paying
|
|
||||||
# full codegen and link cost for a compile check.
|
|
||||||
- target: aarch64-pc-windows-msvc
|
|
||||||
runner: windows-11-arm
|
|
||||||
runs-on: ${{ matrix.runner }}
|
|
||||||
defaults:
|
defaults:
|
||||||
run:
|
run:
|
||||||
working-directory: rust/lancedb
|
working-directory: rust/lancedb
|
||||||
@@ -228,11 +201,6 @@ jobs:
|
|||||||
- name: Set target
|
- name: Set target
|
||||||
run: rustup target add ${{ matrix.target }}
|
run: rustup target add ${{ matrix.target }}
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Install Protoc v21.12
|
- name: Install Protoc v21.12
|
||||||
run: choco install --no-progress protoc
|
run: choco install --no-progress protoc
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -240,12 +208,11 @@ jobs:
|
|||||||
$env:VCPKG_ROOT = $env:VCPKG_INSTALLATION_ROOT
|
$env:VCPKG_ROOT = $env:VCPKG_INSTALLATION_ROOT
|
||||||
cargo build --profile ci --features aws,remote --tests --locked --target ${{ matrix.target }}
|
cargo build --profile ci --features aws,remote --tests --locked --target ${{ matrix.target }}
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
|
# Can only run tests when target matches host
|
||||||
|
if: ${{ matrix.target == 'x86_64-pc-windows-msvc' }}
|
||||||
run: |
|
run: |
|
||||||
$env:VCPKG_ROOT = $env:VCPKG_INSTALLATION_ROOT
|
$env:VCPKG_ROOT = $env:VCPKG_INSTALLATION_ROOT
|
||||||
# `--target` has to match the build step above. Without it cargo uses
|
cargo test --profile ci --features aws,remote --locked
|
||||||
# target/ci/ rather than target/<triple>/ci/ and rebuilds the entire
|
|
||||||
# dependency graph a second time.
|
|
||||||
cargo test --profile ci --features aws,remote --locked --target ${{ matrix.target }}
|
|
||||||
|
|
||||||
msrv:
|
msrv:
|
||||||
# Check the minimum supported Rust version
|
# Check the minimum supported Rust version
|
||||||
@@ -271,11 +238,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
toolchain: ${{ matrix.msrv }}
|
toolchain: ${{ matrix.msrv }}
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
with:
|
|
||||||
# Restore everywhere, but only save from main. Per-PR saves are
|
|
||||||
# unreadable outside their own branch anyway, since GitHub scopes
|
|
||||||
# caches to the creating ref.
|
|
||||||
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
- name: Downgrade dependencies
|
- name: Downgrade dependencies
|
||||||
# These packages have newer requirements for MSRV
|
# These packages have newer requirements for MSRV
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -92,8 +92,6 @@ Python bindings changes:
|
|||||||
* Should use `LOOP.run()` to call the corresponding `AsyncTable` method.
|
* Should use `LOOP.run()` to call the corresponding `AsyncTable` method.
|
||||||
6. Add concrete sync method to `RemoteTable` class in `python/python/lancedb/remote/table.py`.
|
6. Add concrete sync method to `RemoteTable` class in `python/python/lancedb/remote/table.py`.
|
||||||
7. Add unit test in `python/tests/test_table.py`.
|
7. Add unit test in `python/tests/test_table.py`.
|
||||||
8. If you added a new public class or module-level function (not just a method on an
|
|
||||||
existing class), expose it in the API reference. See "Python API reference" below.
|
|
||||||
|
|
||||||
TypeScript bindings changes:
|
TypeScript bindings changes:
|
||||||
|
|
||||||
@@ -105,33 +103,6 @@ TypeScript bindings changes:
|
|||||||
5. Add test in `nodejs/__test__/table.test.ts`.
|
5. Add test in `nodejs/__test__/table.test.ts`.
|
||||||
6. Run `npm run docs` to generate TypeScript documentation.
|
6. Run `npm run docs` to generate TypeScript documentation.
|
||||||
|
|
||||||
## Python API reference
|
|
||||||
|
|
||||||
`docs/src/python/python.md` is the entire Python API reference. It is maintained by
|
|
||||||
hand, and anything not listed there is not rendered at all, so new public classes and
|
|
||||||
module-level functions have to be added explicitly. How depends on the module:
|
|
||||||
|
|
||||||
* `lancedb.index`, `lancedb.embeddings`, `lancedb.remote`, and `lancedb.rerankers` are
|
|
||||||
rendered by a single directive each, driven by the module's `__all__`. Add the new
|
|
||||||
name to `__all__` and it appears; forget, and it is silently omitted.
|
|
||||||
* Everything else (`lancedb`, `lancedb.table`, `lancedb.query`, `lancedb.db`, ...) is
|
|
||||||
listed symbol by symbol. Add a `::: lancedb.<module>.<Name>` line to the matching
|
|
||||||
section, and remember that the page separates synchronous and asynchronous APIs.
|
|
||||||
|
|
||||||
Deliberately undocumented: concrete implementations reached through an abstract base
|
|
||||||
(`LanceTable`, `LanceDBConnection`, `RemoteDBConnection`), query base classes already
|
|
||||||
covered by `inherited_members`, and internal helpers.
|
|
||||||
|
|
||||||
Cross-references in docstrings use mkdocstrings syntax, `[text][lancedb.table.Table]`.
|
|
||||||
Plain relative links such as `[Table](Table)` do not resolve. To check your work:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pip install -r docs/requirements.txt
|
|
||||||
cd docs && PYTHONPATH=. mkdocs build
|
|
||||||
```
|
|
||||||
|
|
||||||
The docs site only builds on pushes to `main`, so this is not covered by PR CI.
|
|
||||||
|
|
||||||
## Review Guidelines
|
## Review Guidelines
|
||||||
|
|
||||||
Please consider the following when reviewing code contributions.
|
Please consider the following when reviewing code contributions.
|
||||||
|
|||||||
Generated
+186
-211
File diff suppressed because it is too large
Load Diff
+14
-14
@@ -13,20 +13,20 @@ categories = ["database-implementations"]
|
|||||||
rust-version = "1.91.0"
|
rust-version = "1.91.0"
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
lance = { "version" = "=10.0.0-beta.5", default-features = false, "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance = { "version" = "=9.0.0-rc.2", default-features = false, "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-core = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-core = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-datagen = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-datagen = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-file = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-file = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-io = { "version" = "=10.0.0-beta.5", default-features = false, "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-io = { "version" = "=9.0.0-rc.2", default-features = false, "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-index = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-index = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-linalg = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-linalg = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-namespace = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-namespace = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-namespace-impls = { "version" = "=10.0.0-beta.5", default-features = false, "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-namespace-impls = { "version" = "=9.0.0-rc.2", default-features = false, "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-table = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-table = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-testing = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-testing = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-datafusion = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-datafusion = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-encoding = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-encoding = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
lance-arrow = { "version" = "=10.0.0-beta.5", "tag" = "v10.0.0-beta.5", "git" = "https://github.com/lance-format/lance.git" }
|
lance-arrow = { "version" = "=9.0.0-rc.2", "tag" = "v9.0.0-rc.2", "git" = "https://github.com/lance-format/lance.git" }
|
||||||
ahash = "0.8"
|
ahash = "0.8"
|
||||||
# Note that this one does not include pyarrow
|
# Note that this one does not include pyarrow
|
||||||
arrow = { version = "58.0.0", optional = false }
|
arrow = { version = "58.0.0", optional = false }
|
||||||
|
|||||||
+3
-3
@@ -2,9 +2,9 @@ set -e
|
|||||||
|
|
||||||
RELEASE_TYPE=${1:-"stable"}
|
RELEASE_TYPE=${1:-"stable"}
|
||||||
BUMP_MINOR=${2:-false}
|
BUMP_MINOR=${2:-false}
|
||||||
HEAD_SHA=$(git rev-parse HEAD)
|
TAG_PREFIX=${3:-"v"} # Such as "python-v"
|
||||||
|
HEAD_SHA=${4:-$(git rev-parse HEAD)}
|
||||||
|
|
||||||
readonly TAG_PREFIX="v"
|
|
||||||
readonly SELF_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
|
readonly SELF_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
|
||||||
|
|
||||||
PREV_TAG=$(git tag --sort='version:refname' | grep ^$TAG_PREFIX | python $SELF_DIR/semver_sort.py $TAG_PREFIX | tail -n 1)
|
PREV_TAG=$(git tag --sort='version:refname' | grep ^$TAG_PREFIX | python $SELF_DIR/semver_sort.py $TAG_PREFIX | tail -n 1)
|
||||||
@@ -12,7 +12,7 @@ echo "Found previous tag $PREV_TAG"
|
|||||||
|
|
||||||
# Initially, we don't want to tag if we are doing stable, because we will bump
|
# Initially, we don't want to tag if we are doing stable, because we will bump
|
||||||
# again later. See comment at end for why.
|
# again later. See comment at end for why.
|
||||||
if [[ "$RELEASE_TYPE" == 'stable' ]]; then
|
if [[ "$RELEASE_TYPE" == 'stable' ]]; then
|
||||||
BUMP_ARGS="--no-tag"
|
BUMP_ARGS="--no-tag"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
@@ -51,11 +51,6 @@ plugins:
|
|||||||
paths: [../python/python]
|
paths: [../python/python]
|
||||||
options:
|
options:
|
||||||
docstring_style: numpy
|
docstring_style: numpy
|
||||||
docstring_options:
|
|
||||||
# Attributes documented in a `Parameters` section, and pydantic
|
|
||||||
# dataclasses whose `__init__` griffe cannot see statically, both
|
|
||||||
# trip this check. It reports nothing actionable here.
|
|
||||||
warn_unknown_params: false
|
|
||||||
heading_level: 3
|
heading_level: 3
|
||||||
show_signature_annotations: true
|
show_signature_annotations: true
|
||||||
show_root_heading: true
|
show_root_heading: true
|
||||||
|
|||||||
+1
-11
@@ -453,16 +453,6 @@ paths:
|
|||||||
The metric type to use for the index. l2, Cosine, Dot are supported.
|
The metric type to use for the index. l2, Cosine, Dot are supported.
|
||||||
index_type:
|
index_type:
|
||||||
type: string
|
type: string
|
||||||
custom_stop_words:
|
|
||||||
type: [array, "null"]
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
The custom stop-word list for an FTS index. A non-null
|
|
||||||
array replaces the language's built-in stop-word list and is only
|
|
||||||
applied when remove_stop_words is enabled. Null uses the built-in
|
|
||||||
language list, while an empty array explicitly replaces it with no
|
|
||||||
stop words.
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: Index successfully created
|
description: Index successfully created
|
||||||
@@ -520,4 +510,4 @@ paths:
|
|||||||
"401":
|
"401":
|
||||||
$ref: "#/components/responses/unauthorized"
|
$ref: "#/components/responses/unauthorized"
|
||||||
"404":
|
"404":
|
||||||
$ref: "#/components/responses/not_found"
|
$ref: "#/components/responses/not_found"
|
||||||
+30
-165
@@ -14,7 +14,7 @@ Add the following dependency to your `pom.xml`:
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.lancedb</groupId>
|
<groupId>com.lancedb</groupId>
|
||||||
<artifactId>lancedb-core</artifactId>
|
<artifactId>lancedb-core</artifactId>
|
||||||
<version>0.37.1-beta.0</version>
|
<version>0.32.0-beta.2</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -249,57 +249,6 @@ try (BufferAllocator allocator = new RootAllocator();
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Creating an Empty Table
|
|
||||||
|
|
||||||
To create an empty table, send an Arrow IPC stream that contains the table schema and no record batches.
|
|
||||||
The schema in the IPC stream becomes the table schema, and rows can be inserted later.
|
|
||||||
|
|
||||||
```java
|
|
||||||
import org.lance.namespace.model.CreateTableRequest;
|
|
||||||
import org.lance.namespace.model.CreateTableResponse;
|
|
||||||
import org.apache.arrow.memory.BufferAllocator;
|
|
||||||
import org.apache.arrow.memory.RootAllocator;
|
|
||||||
import org.apache.arrow.vector.VectorSchemaRoot;
|
|
||||||
import org.apache.arrow.vector.ipc.ArrowStreamWriter;
|
|
||||||
import org.apache.arrow.vector.types.FloatingPointPrecision;
|
|
||||||
import org.apache.arrow.vector.types.pojo.ArrowType;
|
|
||||||
import org.apache.arrow.vector.types.pojo.Field;
|
|
||||||
import org.apache.arrow.vector.types.pojo.FieldType;
|
|
||||||
import org.apache.arrow.vector.types.pojo.Schema;
|
|
||||||
|
|
||||||
import java.io.ByteArrayOutputStream;
|
|
||||||
import java.nio.channels.Channels;
|
|
||||||
import java.util.Arrays;
|
|
||||||
|
|
||||||
Schema schema = new Schema(Arrays.asList(
|
|
||||||
new Field("id", FieldType.nullable(new ArrowType.Int(32, true)), null),
|
|
||||||
new Field("name", FieldType.nullable(new ArrowType.Utf8()), null),
|
|
||||||
new Field("embedding",
|
|
||||||
FieldType.nullable(new ArrowType.FixedSizeList(128)),
|
|
||||||
Arrays.asList(new Field("item",
|
|
||||||
FieldType.nullable(new ArrowType.FloatingPoint(FloatingPointPrecision.SINGLE)),
|
|
||||||
null)))
|
|
||||||
));
|
|
||||||
|
|
||||||
byte[] emptyTableData;
|
|
||||||
try (BufferAllocator allocator = new RootAllocator();
|
|
||||||
VectorSchemaRoot root = VectorSchemaRoot.create(schema, allocator)) {
|
|
||||||
root.setRowCount(0);
|
|
||||||
|
|
||||||
ByteArrayOutputStream out = new ByteArrayOutputStream();
|
|
||||||
try (ArrowStreamWriter writer = new ArrowStreamWriter(root, null, Channels.newChannel(out))) {
|
|
||||||
writer.start();
|
|
||||||
writer.end();
|
|
||||||
}
|
|
||||||
emptyTableData = out.toByteArray();
|
|
||||||
}
|
|
||||||
|
|
||||||
CreateTableRequest request = new CreateTableRequest();
|
|
||||||
request.setId(Arrays.asList("my_namespace", "empty_table"));
|
|
||||||
|
|
||||||
CreateTableResponse response = namespaceClient.createTable(request, emptyTableData);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Insert
|
### Insert
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@@ -482,88 +431,9 @@ query.setVector(vector);
|
|||||||
byte[] result = namespaceClient.queryTable(query);
|
byte[] result = namespaceClient.queryTable(query);
|
||||||
```
|
```
|
||||||
|
|
||||||
## Indexing
|
### Reading Query Results
|
||||||
|
|
||||||
The Java SDK exposes the REST namespace index operations through the same `LanceNamespace` client.
|
Query results are returned in Apache Arrow IPC file format. Here's how to read them:
|
||||||
Index creation runs asynchronously, so use `listTableIndices` or `describeTableIndexStats` to check progress.
|
|
||||||
|
|
||||||
### Creating a Vector Index
|
|
||||||
|
|
||||||
```java
|
|
||||||
import org.lance.namespace.model.CreateTableIndexRequest;
|
|
||||||
import org.lance.namespace.model.CreateTableIndexResponse;
|
|
||||||
|
|
||||||
CreateTableIndexRequest request = new CreateTableIndexRequest();
|
|
||||||
request.setId(Arrays.asList("my_namespace", "my_table"));
|
|
||||||
request.setColumn("embedding");
|
|
||||||
request.setIndexType("IVF_PQ");
|
|
||||||
request.setDistanceType("cosine");
|
|
||||||
request.setName("embedding_idx");
|
|
||||||
|
|
||||||
CreateTableIndexResponse response = namespaceClient.createTableIndex(request);
|
|
||||||
System.out.println("Index transaction: " + response.getTransactionId());
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating a Scalar Index
|
|
||||||
|
|
||||||
```java
|
|
||||||
import org.lance.namespace.model.CreateTableIndexRequest;
|
|
||||||
import org.lance.namespace.model.CreateTableScalarIndexResponse;
|
|
||||||
|
|
||||||
CreateTableIndexRequest request = new CreateTableIndexRequest();
|
|
||||||
request.setId(Arrays.asList("my_namespace", "my_table"));
|
|
||||||
request.setColumn("category");
|
|
||||||
request.setIndexType("BTREE");
|
|
||||||
request.setName("category_idx");
|
|
||||||
|
|
||||||
CreateTableScalarIndexResponse response = namespaceClient.createTableScalarIndex(request);
|
|
||||||
System.out.println("Index transaction: " + response.getTransactionId());
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating a Full Text Search Index
|
|
||||||
|
|
||||||
```java
|
|
||||||
import org.lance.namespace.model.CreateTableIndexRequest;
|
|
||||||
import org.lance.namespace.model.CreateTableScalarIndexResponse;
|
|
||||||
|
|
||||||
CreateTableIndexRequest request = new CreateTableIndexRequest();
|
|
||||||
request.setId(Arrays.asList("my_namespace", "my_table"));
|
|
||||||
request.setColumn("text_column");
|
|
||||||
request.setIndexType("FTS");
|
|
||||||
request.setName("text_idx");
|
|
||||||
request.setBaseTokenizer("simple");
|
|
||||||
request.setLowerCase(true);
|
|
||||||
request.setWithPosition(true);
|
|
||||||
|
|
||||||
CreateTableScalarIndexResponse response = namespaceClient.createTableScalarIndex(request);
|
|
||||||
System.out.println("Index transaction: " + response.getTransactionId());
|
|
||||||
```
|
|
||||||
|
|
||||||
### Listing Indexes
|
|
||||||
|
|
||||||
```java
|
|
||||||
import org.lance.namespace.model.IndexContent;
|
|
||||||
import org.lance.namespace.model.ListTableIndicesRequest;
|
|
||||||
import org.lance.namespace.model.ListTableIndicesResponse;
|
|
||||||
|
|
||||||
ListTableIndicesRequest request = new ListTableIndicesRequest();
|
|
||||||
request.setId(Arrays.asList("my_namespace", "my_table"));
|
|
||||||
|
|
||||||
ListTableIndicesResponse response = namespaceClient.listTableIndices(request);
|
|
||||||
for (IndexContent index : response.getIndexes()) {
|
|
||||||
System.out.println(index.getIndexName() + ": " + index.getStatus());
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
!!! note
|
|
||||||
The current Java namespace API exposes index type, index name, distance type, and full text search tokenizer options.
|
|
||||||
IVF training parameters such as `num_partitions` are not exposed by `CreateTableIndexRequest` yet.
|
|
||||||
To make those configurable from Java, the namespace API must add those fields first.
|
|
||||||
|
|
||||||
## Reading Query Results
|
|
||||||
|
|
||||||
Query results are returned as bytes in Apache Arrow IPC file format. Put the byte-channel
|
|
||||||
adapter behind a small helper so query code can work with `ArrowFileReader` directly:
|
|
||||||
|
|
||||||
```java
|
```java
|
||||||
import org.apache.arrow.vector.ipc.ArrowFileReader;
|
import org.apache.arrow.vector.ipc.ArrowFileReader;
|
||||||
@@ -571,50 +441,45 @@ import org.apache.arrow.vector.VectorSchemaRoot;
|
|||||||
import org.apache.arrow.memory.BufferAllocator;
|
import org.apache.arrow.memory.BufferAllocator;
|
||||||
import org.apache.arrow.memory.RootAllocator;
|
import org.apache.arrow.memory.RootAllocator;
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.nio.ByteBuffer;
|
import java.nio.ByteBuffer;
|
||||||
import java.nio.channels.SeekableByteChannel;
|
import java.nio.channels.SeekableByteChannel;
|
||||||
|
|
||||||
final class ArrowIpc {
|
// Helper class to read Arrow data from byte array
|
||||||
static ArrowFileReader openFileReader(byte[] data, BufferAllocator allocator) throws IOException {
|
class ByteArraySeekableByteChannel implements SeekableByteChannel {
|
||||||
return new ArrowFileReader(new ByteArraySeekableByteChannel(data), allocator);
|
private final byte[] data;
|
||||||
|
private long position = 0;
|
||||||
|
private boolean isOpen = true;
|
||||||
|
|
||||||
|
public ByteArraySeekableByteChannel(byte[] data) {
|
||||||
|
this.data = data;
|
||||||
}
|
}
|
||||||
|
|
||||||
private static final class ByteArraySeekableByteChannel implements SeekableByteChannel {
|
@Override
|
||||||
private final byte[] data;
|
public int read(ByteBuffer dst) {
|
||||||
private long position = 0;
|
int remaining = dst.remaining();
|
||||||
private boolean isOpen = true;
|
int available = (int) (data.length - position);
|
||||||
|
if (available <= 0) return -1;
|
||||||
private ByteArraySeekableByteChannel(byte[] data) {
|
int toRead = Math.min(remaining, available);
|
||||||
this.data = data;
|
dst.put(data, (int) position, toRead);
|
||||||
}
|
position += toRead;
|
||||||
|
return toRead;
|
||||||
@Override
|
|
||||||
public int read(ByteBuffer dst) {
|
|
||||||
int remaining = dst.remaining();
|
|
||||||
int available = (int) (data.length - position);
|
|
||||||
if (available <= 0) return -1;
|
|
||||||
int toRead = Math.min(remaining, available);
|
|
||||||
dst.put(data, (int) position, toRead);
|
|
||||||
position += toRead;
|
|
||||||
return toRead;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public long position() { return position; }
|
|
||||||
@Override public SeekableByteChannel position(long newPosition) { position = newPosition; return this; }
|
|
||||||
@Override public long size() { return data.length; }
|
|
||||||
@Override public boolean isOpen() { return isOpen; }
|
|
||||||
@Override public void close() { isOpen = false; }
|
|
||||||
@Override public int write(ByteBuffer src) { throw new UnsupportedOperationException(); }
|
|
||||||
@Override public SeekableByteChannel truncate(long size) { throw new UnsupportedOperationException(); }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override public long position() { return position; }
|
||||||
|
@Override public SeekableByteChannel position(long newPosition) { position = newPosition; return this; }
|
||||||
|
@Override public long size() { return data.length; }
|
||||||
|
@Override public boolean isOpen() { return isOpen; }
|
||||||
|
@Override public void close() { isOpen = false; }
|
||||||
|
@Override public int write(ByteBuffer src) { throw new UnsupportedOperationException(); }
|
||||||
|
@Override public SeekableByteChannel truncate(long size) { throw new UnsupportedOperationException(); }
|
||||||
}
|
}
|
||||||
|
|
||||||
// Read query results
|
// Read query results
|
||||||
byte[] queryResult = namespaceClient.queryTable(query);
|
byte[] queryResult = namespaceClient.queryTable(query);
|
||||||
|
|
||||||
try (BufferAllocator allocator = new RootAllocator();
|
try (BufferAllocator allocator = new RootAllocator();
|
||||||
ArrowFileReader reader = ArrowIpc.openFileReader(queryResult, allocator)) {
|
ArrowFileReader reader = new ArrowFileReader(
|
||||||
|
new ByteArraySeekableByteChannel(queryResult), allocator)) {
|
||||||
|
|
||||||
for (int i = 0; i < reader.getRecordBlocks().size(); i++) {
|
for (int i = 0; i < reader.getRecordBlocks().size(); i++) {
|
||||||
reader.loadRecordBatch(reader.getRecordBlocks().get(i));
|
reader.loadRecordBatch(reader.getRecordBlocks().get(i));
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Contributing to LanceDB Typescript
|
# Contributing to LanceDB Typescript
|
||||||
|
|
||||||
This document outlines the process for contributing to LanceDB Typescript.
|
This document outlines the process for contributing to LanceDB Typescript.
|
||||||
For general contribution guidelines, see [CONTRIBUTING.md](https://github.com/lancedb/lancedb/blob/main/CONTRIBUTING.md).
|
For general contribution guidelines, see [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||||
|
|
||||||
## Project layout
|
## Project layout
|
||||||
|
|
||||||
|
|||||||
@@ -76,23 +76,24 @@ the query optimizer chooses a suboptimal path.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### useLsm()
|
### useLsmWrite()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
useLsm(enable): MergeInsertBuilder
|
useLsmWrite(useLsmWrite): MergeInsertBuilder
|
||||||
```
|
```
|
||||||
|
|
||||||
Control MemWAL routing for this merge.
|
Controls whether the merge uses the MemWAL LSM write path.
|
||||||
|
|
||||||
By default (unset), a `mergeInsert` on a table with an LSM write spec is
|
By default (unset), a `mergeInsert` on a table with an LSM write spec is
|
||||||
routed through Lance's MemWAL shard writer, and a table without one uses the
|
routed through Lance's MemWAL shard writer, and a table without one uses
|
||||||
standard path.
|
the standard path. Pass `false` to force the standard path even when a
|
||||||
|
spec is set. Pass `true` to require a spec — `mergeInsert` rejects if none
|
||||||
|
is installed.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
* **enable**: `boolean`
|
* **useLsmWrite**: `boolean`
|
||||||
`true` forces MemWAL routing and errors if the table has no
|
Whether to use the LSM write path.
|
||||||
LSM write spec. `false` forces the standard write path even when a spec is set.
|
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
|
|||||||
@@ -497,42 +497,6 @@ ArrowTable.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### useLsm()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
useLsm(enable): this
|
|
||||||
```
|
|
||||||
|
|
||||||
Control MemWAL read routing for this query.
|
|
||||||
|
|
||||||
By default (unset), when the table carries a MemWAL write spec (see
|
|
||||||
[Table#setLsmWriteSpec](Table.md#setlsmwritespec)), reads are routed through the LSM scanner so
|
|
||||||
they also return data written via the `mergeInsert` LSM path that has not yet
|
|
||||||
been compacted into the base table (the active/frozen in-memory memtables and
|
|
||||||
the flushed generations), deduplicated by primary key; a table without a spec
|
|
||||||
reads the base table.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **enable**: `boolean`
|
|
||||||
`true` forces the LSM scanner and errors if the table has no
|
|
||||||
MemWAL write spec. `false` bypasses the MemWAL and reads the base table only,
|
|
||||||
even when a spec is present.
|
|
||||||
Note: the LSM scanner does not support every query shape (e.g. reranking,
|
|
||||||
hybrid search, `orderBy`). On a MemWAL table those shapes error unless
|
|
||||||
`useLsm(false)` is set, because a base-only read would silently exclude
|
|
||||||
un-compacted MemWAL data.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`this`
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`StandardQueryBase.useLsm`
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### where()
|
### where()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -273,29 +273,6 @@ ArrowTable.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### useLsm()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
useLsm(enable): this
|
|
||||||
```
|
|
||||||
|
|
||||||
Control MemWAL read routing for this take query.
|
|
||||||
|
|
||||||
`false` bypasses the MemWAL and reads the base table only — the escape hatch,
|
|
||||||
since take-by-row-id/offset is not supported on the LSM scanner and, on a
|
|
||||||
MemWAL table, auto-routes to it and errors otherwise.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **enable**: `boolean`
|
|
||||||
`false` reads the base table only.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`this`
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### withRowId()
|
### withRowId()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -746,42 +746,6 @@ ArrowTable.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### useLsm()
|
|
||||||
|
|
||||||
```ts
|
|
||||||
useLsm(enable): this
|
|
||||||
```
|
|
||||||
|
|
||||||
Control MemWAL read routing for this query.
|
|
||||||
|
|
||||||
By default (unset), when the table carries a MemWAL write spec (see
|
|
||||||
[Table#setLsmWriteSpec](Table.md#setlsmwritespec)), reads are routed through the LSM scanner so
|
|
||||||
they also return data written via the `mergeInsert` LSM path that has not yet
|
|
||||||
been compacted into the base table (the active/frozen in-memory memtables and
|
|
||||||
the flushed generations), deduplicated by primary key; a table without a spec
|
|
||||||
reads the base table.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
* **enable**: `boolean`
|
|
||||||
`true` forces the LSM scanner and errors if the table has no
|
|
||||||
MemWAL write spec. `false` bypasses the MemWAL and reads the base table only,
|
|
||||||
even when a spec is present.
|
|
||||||
Note: the LSM scanner does not support every query shape (e.g. reranking,
|
|
||||||
hybrid search, `orderBy`). On a MemWAL table those shapes error unless
|
|
||||||
`useLsm(false)` is set, because a base-only read would silently exclude
|
|
||||||
un-compacted MemWAL data.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`this`
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`StandardQueryBase.useLsm`
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### where()
|
### where()
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -43,34 +43,6 @@ The following tokenizers are available:
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### blockSize?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional blockSize: 128 | 256;
|
|
||||||
```
|
|
||||||
|
|
||||||
Number of documents per compressed posting block.
|
|
||||||
|
|
||||||
The default is 128. Supported values are 128 and 256. A value of 256 uses
|
|
||||||
the experimental FTS V3 format and may introduce breaking changes.
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### customStopWords?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional customStopWords: string[];
|
|
||||||
```
|
|
||||||
|
|
||||||
Custom stop words that replace the built-in list for `language`.
|
|
||||||
|
|
||||||
This option only affects tokenization when `removeStopWords` is true.
|
|
||||||
|
|
||||||
`undefined` keeps the built-in language list. An empty array explicitly
|
|
||||||
replaces it with no stop words.
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### language?
|
### language?
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
@@ -30,21 +30,6 @@ The tokenizer to use. The default is "simple".
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
### customStopWords?
|
|
||||||
|
|
||||||
```ts
|
|
||||||
optional customStopWords: string[];
|
|
||||||
```
|
|
||||||
|
|
||||||
Custom stop words that replace the built-in list for `language`.
|
|
||||||
|
|
||||||
This option only affects tokenization when `removeStopWords` is true.
|
|
||||||
|
|
||||||
`undefined` keeps the built-in language list. An empty array explicitly
|
|
||||||
replaces it with no stop words.
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### language?
|
### language?
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
+52
-141
@@ -26,18 +26,6 @@ is also an [asynchronous API client](#connections-asynchronous).
|
|||||||
|
|
||||||
::: lancedb.db.DBConnection
|
::: lancedb.db.DBConnection
|
||||||
|
|
||||||
::: lancedb.Session
|
|
||||||
|
|
||||||
## Namespaces (Synchronous)
|
|
||||||
|
|
||||||
A namespace-backed connection resolves tables through a
|
|
||||||
[Lance namespace](https://lancedb.github.io/lance-namespace/) service instead of
|
|
||||||
listing a storage directory.
|
|
||||||
|
|
||||||
::: lancedb.connect_namespace
|
|
||||||
|
|
||||||
::: lancedb.namespace.LanceNamespaceDBConnection
|
|
||||||
|
|
||||||
## Tables (Synchronous)
|
## Tables (Synchronous)
|
||||||
|
|
||||||
::: lancedb.table.Table
|
::: lancedb.table.Table
|
||||||
@@ -46,12 +34,8 @@ listing a storage directory.
|
|||||||
|
|
||||||
::: lancedb.table.FragmentSummaryStats
|
::: lancedb.table.FragmentSummaryStats
|
||||||
|
|
||||||
::: lancedb.table.TableStatistics
|
|
||||||
|
|
||||||
::: lancedb.table.Tags
|
::: lancedb.table.Tags
|
||||||
|
|
||||||
::: lancedb.table.Branches
|
|
||||||
|
|
||||||
## Expressions
|
## Expressions
|
||||||
|
|
||||||
Type-safe expression builder for filters and projections. Use these instead
|
Type-safe expression builder for filters and projections. Use these instead
|
||||||
@@ -78,46 +62,29 @@ of raw SQL strings with [where][lancedb.query.LanceQueryBuilder.where] and
|
|||||||
|
|
||||||
::: lancedb.query.LanceHybridQueryBuilder
|
::: lancedb.query.LanceHybridQueryBuilder
|
||||||
|
|
||||||
::: lancedb.query.LanceEmptyQueryBuilder
|
|
||||||
|
|
||||||
::: lancedb.query.LanceTakeQueryBuilder
|
|
||||||
|
|
||||||
## Full text queries
|
|
||||||
|
|
||||||
Structured full text queries can be passed to
|
|
||||||
[Table.search][lancedb.table.Table.search] or
|
|
||||||
[AsyncTable.search][lancedb.table.AsyncTable.search] in place of a query string,
|
|
||||||
and combined with [BooleanQuery][lancedb.query.BooleanQuery].
|
|
||||||
|
|
||||||
::: lancedb.query.FullTextQuery
|
|
||||||
|
|
||||||
::: lancedb.query.MatchQuery
|
|
||||||
|
|
||||||
::: lancedb.query.PhraseQuery
|
|
||||||
|
|
||||||
::: lancedb.query.BoostQuery
|
|
||||||
|
|
||||||
::: lancedb.query.MultiMatchQuery
|
|
||||||
|
|
||||||
::: lancedb.query.BooleanQuery
|
|
||||||
|
|
||||||
::: lancedb.query.FullTextOperator
|
|
||||||
|
|
||||||
::: lancedb.query.Occur
|
|
||||||
|
|
||||||
## Embeddings
|
## Embeddings
|
||||||
|
|
||||||
::: lancedb.embeddings
|
::: lancedb.embeddings.registry.EmbeddingFunctionRegistry
|
||||||
options:
|
|
||||||
show_root_heading: false
|
::: lancedb.embeddings.base.EmbeddingFunctionConfig
|
||||||
show_root_toc_entry: false
|
|
||||||
|
::: lancedb.embeddings.base.EmbeddingFunction
|
||||||
|
|
||||||
|
::: lancedb.embeddings.base.TextEmbeddingFunction
|
||||||
|
|
||||||
|
::: lancedb.embeddings.sentence_transformers.SentenceTransformerEmbeddings
|
||||||
|
|
||||||
|
::: lancedb.embeddings.openai.OpenAIEmbeddings
|
||||||
|
|
||||||
|
::: lancedb.embeddings.open_clip.OpenClipEmbeddings
|
||||||
|
|
||||||
## Remote configuration
|
## Remote configuration
|
||||||
|
|
||||||
::: lancedb.remote
|
::: lancedb.remote.ClientConfig
|
||||||
options:
|
|
||||||
show_root_heading: false
|
::: lancedb.remote.TimeoutConfig
|
||||||
show_root_toc_entry: false
|
|
||||||
|
::: lancedb.remote.RetryConfig
|
||||||
|
|
||||||
## Context
|
## Context
|
||||||
|
|
||||||
@@ -127,50 +94,11 @@ and combined with [BooleanQuery][lancedb.query.BooleanQuery].
|
|||||||
|
|
||||||
## Full text search
|
## Full text search
|
||||||
|
|
||||||
Pass `custom_stop_words` to [lancedb.index.FTS][]:
|
Use [lancedb.table.Table.create_fts_index][] for the synchronous API or
|
||||||
|
[lancedb.table.AsyncTable.create_index][] with [lancedb.index.FTS][] for the
|
||||||
|
asynchronous API.
|
||||||
|
|
||||||
```python
|
::: lancedb.index.FTS
|
||||||
from lancedb.index import FTS
|
|
||||||
|
|
||||||
table.create_index(
|
|
||||||
"text",
|
|
||||||
config=FTS(remove_stop_words=True, custom_stop_words=["acme", "internal"]),
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
The list replaces the built-in stop words and is used only when
|
|
||||||
`remove_stop_words=True`:
|
|
||||||
|
|
||||||
- `custom_stop_words=None` uses the built-in list for `language`.
|
|
||||||
- `custom_stop_words=[]` removes no words.
|
|
||||||
- Values are passed through without trimming, lowercasing, or other rewriting.
|
|
||||||
|
|
||||||
The same option is available on `lancedb.tokenize(...)` and the deprecated
|
|
||||||
[lancedb.table.Table.create_fts_index][] compatibility helper:
|
|
||||||
|
|
||||||
```python
|
|
||||||
import lancedb
|
|
||||||
|
|
||||||
tokens = list(lancedb.tokenize("acme makes searchable data",
|
|
||||||
custom_stop_words=["acme"]))
|
|
||||||
```
|
|
||||||
|
|
||||||
::: lancedb.tokenize
|
|
||||||
|
|
||||||
::: lancedb.FtsToken
|
|
||||||
|
|
||||||
## Blobs
|
|
||||||
|
|
||||||
Blob columns store large binary values out of line so they can be read lazily
|
|
||||||
instead of being materialized with the rest of the row.
|
|
||||||
|
|
||||||
::: lancedb.blob
|
|
||||||
|
|
||||||
::: lancedb.BlobType
|
|
||||||
|
|
||||||
::: lancedb._blob.BlobFile
|
|
||||||
options:
|
|
||||||
show_root_full_path: false
|
|
||||||
|
|
||||||
## Utilities
|
## Utilities
|
||||||
|
|
||||||
@@ -178,14 +106,6 @@ instead of being materialized with the rest of the row.
|
|||||||
|
|
||||||
::: lancedb.merge.LanceMergeInsertBuilder
|
::: lancedb.merge.LanceMergeInsertBuilder
|
||||||
|
|
||||||
::: lancedb.otel.instrument_lancedb_metrics
|
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
|
|
||||||
::: lancedb.exceptions.MissingValueError
|
|
||||||
|
|
||||||
::: lancedb.exceptions.MissingColumnError
|
|
||||||
|
|
||||||
## Integrations
|
## Integrations
|
||||||
|
|
||||||
## Pydantic
|
## Pydantic
|
||||||
@@ -194,30 +114,19 @@ instead of being materialized with the rest of the row.
|
|||||||
|
|
||||||
::: lancedb.pydantic.vector
|
::: lancedb.pydantic.vector
|
||||||
|
|
||||||
::: lancedb.pydantic.Vector
|
|
||||||
|
|
||||||
::: lancedb.pydantic.MultiVector
|
|
||||||
|
|
||||||
::: lancedb.pydantic.LanceModel
|
::: lancedb.pydantic.LanceModel
|
||||||
|
|
||||||
## PyTorch
|
|
||||||
|
|
||||||
::: lancedb.streaming.StreamingDataset
|
|
||||||
|
|
||||||
::: lancedb.permutation.permutation_builder
|
|
||||||
|
|
||||||
::: lancedb.permutation.PermutationBuilder
|
|
||||||
|
|
||||||
::: lancedb.permutation.Permutation
|
|
||||||
|
|
||||||
::: lancedb.permutation.Transforms
|
|
||||||
|
|
||||||
## Reranking
|
## Reranking
|
||||||
|
|
||||||
::: lancedb.rerankers
|
::: lancedb.rerankers.linear_combination.LinearCombinationReranker
|
||||||
options:
|
|
||||||
show_root_heading: false
|
::: lancedb.rerankers.cohere.CohereReranker
|
||||||
show_root_toc_entry: false
|
|
||||||
|
::: lancedb.rerankers.colbert.ColbertReranker
|
||||||
|
|
||||||
|
::: lancedb.rerankers.cross_encoder.CrossEncoderReranker
|
||||||
|
|
||||||
|
::: lancedb.rerankers.openai.OpenaiReranker
|
||||||
|
|
||||||
## Connections (Asynchronous)
|
## Connections (Asynchronous)
|
||||||
|
|
||||||
@@ -228,12 +137,6 @@ can be used to create, list, or open tables.
|
|||||||
|
|
||||||
::: lancedb.db.AsyncConnection
|
::: lancedb.db.AsyncConnection
|
||||||
|
|
||||||
## Namespaces (Asynchronous)
|
|
||||||
|
|
||||||
::: lancedb.connect_namespace_async
|
|
||||||
|
|
||||||
::: lancedb.namespace.AsyncLanceNamespaceDBConnection
|
|
||||||
|
|
||||||
## Tables (Asynchronous)
|
## Tables (Asynchronous)
|
||||||
|
|
||||||
Table hold your actual data as a collection of records / rows.
|
Table hold your actual data as a collection of records / rows.
|
||||||
@@ -242,20 +145,32 @@ Table hold your actual data as a collection of records / rows.
|
|||||||
|
|
||||||
::: lancedb.table.AsyncTags
|
::: lancedb.table.AsyncTags
|
||||||
|
|
||||||
::: lancedb.table.AsyncBranches
|
|
||||||
|
|
||||||
## Indices (Asynchronous)
|
## Indices (Asynchronous)
|
||||||
|
|
||||||
Indices can be created on a table to speed up queries. This section
|
Indices can be created on a table to speed up queries. This section
|
||||||
lists the indices that LanceDb supports.
|
lists the indices that LanceDb supports.
|
||||||
|
|
||||||
::: lancedb.index
|
::: lancedb.index.BTree
|
||||||
options:
|
|
||||||
show_root_heading: false
|
::: lancedb.index.Bitmap
|
||||||
show_root_toc_entry: false
|
|
||||||
# `lang_mapping` is defined in the module rather than imported, so it is
|
::: lancedb.index.LabelList
|
||||||
# picked up despite not being in `__all__`. It is an internal lookup table.
|
|
||||||
filters: ["!^_", "!^lang_mapping$"]
|
::: lancedb.index.FTS
|
||||||
|
|
||||||
|
::: lancedb.index.IvfPq
|
||||||
|
|
||||||
|
::: lancedb.index.HnswPq
|
||||||
|
|
||||||
|
::: lancedb.index.HnswSq
|
||||||
|
|
||||||
|
::: lancedb.index.IvfFlat
|
||||||
|
|
||||||
|
::: lancedb.index.IvfSq
|
||||||
|
|
||||||
|
::: lancedb.index.IvfRq
|
||||||
|
|
||||||
|
::: lancedb.index.HnswFlat
|
||||||
|
|
||||||
::: lancedb.table.IndexStatistics
|
::: lancedb.table.IndexStatistics
|
||||||
|
|
||||||
@@ -283,7 +198,3 @@ rows nearest to a query vector and can be created with the
|
|||||||
::: lancedb.query.AsyncHybridQuery
|
::: lancedb.query.AsyncHybridQuery
|
||||||
options:
|
options:
|
||||||
inherited_members: true
|
inherited_members: true
|
||||||
|
|
||||||
::: lancedb.query.AsyncTakeQuery
|
|
||||||
options:
|
|
||||||
inherited_members: true
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>com.lancedb</groupId>
|
<groupId>com.lancedb</groupId>
|
||||||
<artifactId>lancedb-parent</artifactId>
|
<artifactId>lancedb-parent</artifactId>
|
||||||
<version>0.37.1-beta.0</version>
|
<version>0.32.0-beta.2</version>
|
||||||
<relativePath>../pom.xml</relativePath>
|
<relativePath>../pom.xml</relativePath>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
<groupId>com.lancedb</groupId>
|
<groupId>com.lancedb</groupId>
|
||||||
<artifactId>lancedb-parent</artifactId>
|
<artifactId>lancedb-parent</artifactId>
|
||||||
<version>0.37.1-beta.0</version>
|
<version>0.32.0-beta.2</version>
|
||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
<name>${project.artifactId}</name>
|
<name>${project.artifactId}</name>
|
||||||
<description>LanceDB Java SDK Parent POM</description>
|
<description>LanceDB Java SDK Parent POM</description>
|
||||||
@@ -28,7 +28,7 @@
|
|||||||
<properties>
|
<properties>
|
||||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||||
<arrow.version>15.0.0</arrow.version>
|
<arrow.version>15.0.0</arrow.version>
|
||||||
<lance-core.version>10.0.0-beta.5</lance-core.version>
|
<lance-core.version>9.0.0-rc.2</lance-core.version>
|
||||||
<spotless.skip>false</spotless.skip>
|
<spotless.skip>false</spotless.skip>
|
||||||
<spotless.version>2.30.0</spotless.version>
|
<spotless.version>2.30.0</spotless.version>
|
||||||
<spotless.java.googlejavaformat.version>1.7</spotless.java.googlejavaformat.version>
|
<spotless.java.googlejavaformat.version>1.7</spotless.java.googlejavaformat.version>
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Contributing to LanceDB Typescript
|
# Contributing to LanceDB Typescript
|
||||||
|
|
||||||
This document outlines the process for contributing to LanceDB Typescript.
|
This document outlines the process for contributing to LanceDB Typescript.
|
||||||
For general contribution guidelines, see [CONTRIBUTING.md](https://github.com/lancedb/lancedb/blob/main/CONTRIBUTING.md).
|
For general contribution guidelines, see [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||||
|
|
||||||
## Project layout
|
## Project layout
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "lancedb-nodejs"
|
name = "lancedb-nodejs"
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
version = "0.37.1-beta.0"
|
version = "0.32.0-beta.2"
|
||||||
publish = false
|
publish = false
|
||||||
license.workspace = true
|
license.workspace = true
|
||||||
description.workspace = true
|
description.workspace = true
|
||||||
|
|||||||
@@ -991,37 +991,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
|
|
||||||
expectValidMapField(roundTripped.schema.fields[0]);
|
expectValidMapField(roundTripped.schema.fields[0]);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("preserves string schema metadata", function () {
|
|
||||||
const metadata = new Map([["source", "fixture"]]);
|
|
||||||
const schema = new Schema(
|
|
||||||
[new Field("value", new Int32(), true)],
|
|
||||||
metadata,
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(makeEmptyTable(schema).schema.metadata.get("source")).toBe(
|
|
||||||
"fixture",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
["non-string keys", new Map<unknown, unknown>([[42, "fixture"]])],
|
|
||||||
["non-string values", new Map<unknown, unknown>([["source", 42]])],
|
|
||||||
[
|
|
||||||
"non-string keys and values",
|
|
||||||
new Map<unknown, unknown>([[42, false]]),
|
|
||||||
],
|
|
||||||
])("rejects schema metadata with %s", function (_, metadataLike) {
|
|
||||||
const metadata = metadataLike as unknown as Map<string, string>;
|
|
||||||
const schema = new Schema(
|
|
||||||
[new Field("value", new Int32(), true)],
|
|
||||||
metadata,
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(() => makeEmptyTable(schema)).toThrow(
|
|
||||||
"Expected metadata, if present, to be a Map<string, string> but it had non-string keys or values",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("when using two versions of arrow", function () {
|
describe("when using two versions of arrow", function () {
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ import {
|
|||||||
OAuthHeaderProvider,
|
OAuthHeaderProvider,
|
||||||
StaticHeaderProvider,
|
StaticHeaderProvider,
|
||||||
} from "../lancedb/header";
|
} from "../lancedb/header";
|
||||||
import { Index } from "../lancedb/indices";
|
|
||||||
|
|
||||||
// Test-only header providers
|
// Test-only header providers
|
||||||
class CustomProvider extends HeaderProvider {
|
class CustomProvider extends HeaderProvider {
|
||||||
@@ -226,59 +225,6 @@ describe("remote connection", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("sends FTS options to remote tables", async () => {
|
|
||||||
let createIndexBody: Record<string, unknown> | undefined;
|
|
||||||
|
|
||||||
await withMockDatabase(
|
|
||||||
(req, res) => {
|
|
||||||
const path = req.url ?? "";
|
|
||||||
if (path.endsWith("/describe/")) {
|
|
||||||
res.writeHead(200, { "Content-Type": "application/json" }).end(
|
|
||||||
JSON.stringify({
|
|
||||||
name: "t",
|
|
||||||
version: 1,
|
|
||||||
schema: {
|
|
||||||
fields: [
|
|
||||||
{ name: "text", type: { type: "string" }, nullable: false },
|
|
||||||
],
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (path.endsWith("/create_index/")) {
|
|
||||||
let raw = "";
|
|
||||||
req.on("data", (chunk) => {
|
|
||||||
raw += chunk;
|
|
||||||
});
|
|
||||||
req.on("end", () => {
|
|
||||||
createIndexBody = JSON.parse(raw);
|
|
||||||
res.writeHead(200).end();
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
res.writeHead(404).end();
|
|
||||||
},
|
|
||||||
async (db) => {
|
|
||||||
const table = await db.openTable("t");
|
|
||||||
await table.createIndex("text", {
|
|
||||||
config: Index.fts({
|
|
||||||
blockSize: 256,
|
|
||||||
removeStopWords: true,
|
|
||||||
customStopWords: ["the"],
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(createIndexBody?.["column"]).toBe("text");
|
|
||||||
expect(createIndexBody?.["index_type"]).toBe("FTS");
|
|
||||||
expect(createIndexBody?.["block_size"]).toBe(256);
|
|
||||||
expect(createIndexBody?.["custom_stop_words"]).toEqual(["the"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("diffs and merges remote branches", async () => {
|
it("diffs and merges remote branches", async () => {
|
||||||
const sampleDiff = {
|
const sampleDiff = {
|
||||||
fromBranch: "exp",
|
fromBranch: "exp",
|
||||||
|
|||||||
@@ -527,14 +527,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should expose useLsm on takeRowIds as the base-only escape hatch", async () => {
|
|
||||||
await table.add([{ id: 1 }, { id: 2 }, { id: 3 }]);
|
|
||||||
// useLsm(false) is reachable on TakeQuery (the escape hatch for MemWAL tables,
|
|
||||||
// where take-by-row-id auto-routes to the LSM scanner and is rejected).
|
|
||||||
const res = await table.takeRowIds([0, 2]).useLsm(false).toArray();
|
|
||||||
expect(res.map((r) => r.id)).toEqual([1, 3]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should throw for negative number in takeRowIds", () => {
|
it("should throw for negative number in takeRowIds", () => {
|
||||||
expect(() => table.takeRowIds([-1])).toThrow("Row id cannot be negative");
|
expect(() => table.takeRowIds([-1])).toThrow("Row id cannot be negative");
|
||||||
expect(() => table.takeRowIds([0, -5, 2])).toThrow(
|
expect(() => table.takeRowIds([0, -5, 2])).toThrow(
|
||||||
@@ -2535,35 +2527,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
expect(results3.length).toBe(1);
|
expect(results3.length).toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("full text search with custom posting block size", async () => {
|
|
||||||
const db = await connect(tmpDir.name);
|
|
||||||
const data = [
|
|
||||||
{ text: "hello world", vector: [0.1, 0.2, 0.3] },
|
|
||||||
{ text: "goodbye world", vector: [0.4, 0.5, 0.6] },
|
|
||||||
];
|
|
||||||
const table = await db.createTable("test", data);
|
|
||||||
await table.createIndex("text", {
|
|
||||||
config: Index.fts({ blockSize: 256 }),
|
|
||||||
});
|
|
||||||
|
|
||||||
const index = (await table.listIndices()).find(
|
|
||||||
(index) => index.indexType === "FTS",
|
|
||||||
);
|
|
||||||
expect(index?.indexVersion).toBe(3);
|
|
||||||
expect(
|
|
||||||
(index?.indexDetails as Record<string, unknown>)["block_size"],
|
|
||||||
).toBe(256);
|
|
||||||
|
|
||||||
const results = await table.search("hello").toArray();
|
|
||||||
expect(results[0].text).toBe(data[0].text);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("rejects invalid full text posting block size", () => {
|
|
||||||
expect(() => Index.fts({ blockSize: 129 as 128 | 256 })).toThrow(
|
|
||||||
"128 or 256",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("full text search without lowercase", async () => {
|
test("full text search without lowercase", async () => {
|
||||||
const db = await connect(tmpDir.name);
|
const db = await connect(tmpDir.name);
|
||||||
const data = [
|
const data = [
|
||||||
@@ -2769,15 +2732,6 @@ describe.each([arrow15, arrow16, arrow17, arrow18])(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test("tokenize supports custom stop words", async () => {
|
|
||||||
const tokens = await tokenize("the lance data", {
|
|
||||||
stem: false,
|
|
||||||
removeStopWords: true,
|
|
||||||
customStopWords: ["lance"],
|
|
||||||
});
|
|
||||||
expect(tokens.map((token) => token.text)).toEqual(["the", "data"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("when calling explainPlan", () => {
|
describe("when calling explainPlan", () => {
|
||||||
let tmpDir: tmp.DirResult;
|
let tmpDir: tmp.DirResult;
|
||||||
let table: Table;
|
let table: Table;
|
||||||
@@ -3216,14 +3170,14 @@ describe("LSM merge insert", () => {
|
|||||||
await table.closeLsmWriters();
|
await table.closeLsmWriters();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("falls back to the standard path with useLsm(false)", async () => {
|
it("falls back to the standard path with useLsmWrite(false)", async () => {
|
||||||
const conn = await connect(tmpDir.name);
|
const conn = await connect(tmpDir.name);
|
||||||
const table = await bucketTable(conn);
|
const table = await bucketTable(conn);
|
||||||
|
|
||||||
const res = await table
|
const res = await table
|
||||||
.mergeInsert("id")
|
.mergeInsert("id")
|
||||||
.whenNotMatchedInsertAll()
|
.whenNotMatchedInsertAll()
|
||||||
.useLsm(false)
|
.useLsmWrite(false)
|
||||||
.execute([
|
.execute([
|
||||||
{ id: "b", value: 9 },
|
{ id: "b", value: 9 },
|
||||||
{ id: "e", value: 5 },
|
{ id: "e", value: 5 },
|
||||||
@@ -3257,36 +3211,4 @@ describe("LSM merge insert", () => {
|
|||||||
.execute([{ id: "g", value: 7 }]),
|
.execute([{ id: "g", value: 7 }]),
|
||||||
).rejects.toThrow();
|
).rejects.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("auto-routes reads through the MemWAL scanner", async () => {
|
|
||||||
const conn = await connect(tmpDir.name);
|
|
||||||
const table = await bucketTable(conn); // base ids "a", "b"
|
|
||||||
|
|
||||||
await table
|
|
||||||
.mergeInsert("id")
|
|
||||||
.whenMatchedUpdateAll()
|
|
||||||
.whenNotMatchedInsertAll()
|
|
||||||
.execute([{ id: "c", value: 3 }]);
|
|
||||||
|
|
||||||
// Default read auto-routes and includes the active memtable row.
|
|
||||||
const lsm = await table.query().toArray();
|
|
||||||
expect(lsm.map((r) => r.id).sort()).toEqual(["a", "b", "c"]);
|
|
||||||
|
|
||||||
// useLsm(false) bypasses the MemWAL and reads the base table only.
|
|
||||||
const baseOnly = await table.query().useLsm(false).toArray();
|
|
||||||
expect(baseOnly.map((r) => r.id).sort()).toEqual(["a", "b"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("reads the base table when no LSM spec is installed", async () => {
|
|
||||||
const conn = await connect(tmpDir.name);
|
|
||||||
const table = await conn.createEmptyTable(
|
|
||||||
"plain",
|
|
||||||
new arrow.Schema([new arrow.Field("id", new arrow.Utf8(), false)]),
|
|
||||||
);
|
|
||||||
// No spec: default read and useLsm(false) both succeed against the base table.
|
|
||||||
await expect(table.query().toArray()).resolves.toBeDefined();
|
|
||||||
await expect(table.query().useLsm(false).toArray()).resolves.toBeDefined();
|
|
||||||
// useLsm(true) demands MemWAL routing; without a spec it errors.
|
|
||||||
await expect(table.query().useLsm(true).toArray()).rejects.toThrow();
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -29,14 +29,8 @@ test("full text search", async () => {
|
|||||||
const tbl = await db.createTable("myVectors", data, { mode: "overwrite" });
|
const tbl = await db.createTable("myVectors", data, { mode: "overwrite" });
|
||||||
|
|
||||||
await tbl.createIndex("doc", {
|
await tbl.createIndex("doc", {
|
||||||
config: lancedb.Index.fts({
|
config: lancedb.Index.fts(),
|
||||||
stem: false,
|
|
||||||
removeStopWords: true,
|
|
||||||
customStopWords: ["banana"],
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
const tokens = await tbl.tokenize("apple banana", { column: "doc" });
|
|
||||||
expect(tokens.map((token) => token.text)).toEqual(["apple"]);
|
|
||||||
|
|
||||||
// --8<-- [start:full_text_search]
|
// --8<-- [start:full_text_search]
|
||||||
const result = await tbl
|
const result = await tbl
|
||||||
|
|||||||
@@ -194,16 +194,6 @@ export interface TokenizeOptions {
|
|||||||
/** Whether to remove stop words. */
|
/** Whether to remove stop words. */
|
||||||
removeStopWords?: boolean;
|
removeStopWords?: boolean;
|
||||||
|
|
||||||
/**
|
|
||||||
* Custom stop words that replace the built-in list for `language`.
|
|
||||||
*
|
|
||||||
* This option only affects tokenization when `removeStopWords` is true.
|
|
||||||
*
|
|
||||||
* `undefined` keeps the built-in language list. An empty array explicitly
|
|
||||||
* replaces it with no stop words.
|
|
||||||
*/
|
|
||||||
customStopWords?: string[];
|
|
||||||
|
|
||||||
/** Whether to fold ASCII characters. */
|
/** Whether to fold ASCII characters. */
|
||||||
asciiFolding?: boolean;
|
asciiFolding?: boolean;
|
||||||
|
|
||||||
@@ -235,7 +225,6 @@ export async function tokenize(
|
|||||||
options?.lowercase,
|
options?.lowercase,
|
||||||
options?.stem,
|
options?.stem,
|
||||||
options?.removeStopWords,
|
options?.removeStopWords,
|
||||||
options?.customStopWords,
|
|
||||||
options?.asciiFolding,
|
options?.asciiFolding,
|
||||||
options?.ngramMinLength,
|
options?.ngramMinLength,
|
||||||
options?.ngramMaxLength,
|
options?.ngramMaxLength,
|
||||||
|
|||||||
@@ -553,16 +553,6 @@ export interface FtsOptions {
|
|||||||
*/
|
*/
|
||||||
removeStopWords?: boolean;
|
removeStopWords?: boolean;
|
||||||
|
|
||||||
/**
|
|
||||||
* Custom stop words that replace the built-in list for `language`.
|
|
||||||
*
|
|
||||||
* This option only affects tokenization when `removeStopWords` is true.
|
|
||||||
*
|
|
||||||
* `undefined` keeps the built-in language list. An empty array explicitly
|
|
||||||
* replaces it with no stop words.
|
|
||||||
*/
|
|
||||||
customStopWords?: string[];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* whether to remove punctuation
|
* whether to remove punctuation
|
||||||
*/
|
*/
|
||||||
@@ -582,14 +572,6 @@ export interface FtsOptions {
|
|||||||
* whether to only index the prefix of the token for ngram tokenizer
|
* whether to only index the prefix of the token for ngram tokenizer
|
||||||
*/
|
*/
|
||||||
prefixOnly?: boolean;
|
prefixOnly?: boolean;
|
||||||
|
|
||||||
/**
|
|
||||||
* Number of documents per compressed posting block.
|
|
||||||
*
|
|
||||||
* The default is 128. Supported values are 128 and 256. A value of 256 uses
|
|
||||||
* the experimental FTS V3 format and may introduce breaking changes.
|
|
||||||
*/
|
|
||||||
blockSize?: 128 | 256;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Index {
|
export class Index {
|
||||||
@@ -765,12 +747,10 @@ export class Index {
|
|||||||
options?.lowercase,
|
options?.lowercase,
|
||||||
options?.stem,
|
options?.stem,
|
||||||
options?.removeStopWords,
|
options?.removeStopWords,
|
||||||
options?.customStopWords,
|
|
||||||
options?.asciiFolding,
|
options?.asciiFolding,
|
||||||
options?.ngramMinLength,
|
options?.ngramMinLength,
|
||||||
options?.ngramMaxLength,
|
options?.ngramMaxLength,
|
||||||
options?.prefixOnly,
|
options?.prefixOnly,
|
||||||
options?.blockSize,
|
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
+11
-7
@@ -88,17 +88,21 @@ export class MergeInsertBuilder {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Control MemWAL routing for this merge.
|
* Controls whether the merge uses the MemWAL LSM write path.
|
||||||
*
|
*
|
||||||
* By default (unset), a `mergeInsert` on a table with an LSM write spec is
|
* By default (unset), a `mergeInsert` on a table with an LSM write spec is
|
||||||
* routed through Lance's MemWAL shard writer, and a table without one uses the
|
* routed through Lance's MemWAL shard writer, and a table without one uses
|
||||||
* standard path.
|
* the standard path. Pass `false` to force the standard path even when a
|
||||||
|
* spec is set. Pass `true` to require a spec — `mergeInsert` rejects if none
|
||||||
|
* is installed.
|
||||||
*
|
*
|
||||||
* @param enable - `true` forces MemWAL routing and errors if the table has no
|
* @param useLsmWrite - Whether to use the LSM write path.
|
||||||
* LSM write spec. `false` forces the standard write path even when a spec is set.
|
|
||||||
*/
|
*/
|
||||||
useLsm(enable: boolean): MergeInsertBuilder {
|
useLsmWrite(useLsmWrite: boolean): MergeInsertBuilder {
|
||||||
return new MergeInsertBuilder(this.#native.useLsm(enable), this.#schema);
|
return new MergeInsertBuilder(
|
||||||
|
this.#native.useLsmWrite(useLsmWrite),
|
||||||
|
this.#schema,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Controls how an LSM merge checks that its input targets a single shard.
|
* Controls how an LSM merge checks that its input targets a single shard.
|
||||||
|
|||||||
@@ -460,30 +460,6 @@ export class StandardQueryBase<
|
|||||||
this.doCall((inner: NativeQueryType) => inner.fastSearch());
|
this.doCall((inner: NativeQueryType) => inner.fastSearch());
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Control MemWAL read routing for this query.
|
|
||||||
*
|
|
||||||
* By default (unset), when the table carries a MemWAL write spec (see
|
|
||||||
* {@link Table#setLsmWriteSpec}), reads are routed through the LSM scanner so
|
|
||||||
* they also return data written via the `mergeInsert` LSM path that has not yet
|
|
||||||
* been compacted into the base table (the active/frozen in-memory memtables and
|
|
||||||
* the flushed generations), deduplicated by primary key; a table without a spec
|
|
||||||
* reads the base table.
|
|
||||||
*
|
|
||||||
* @param enable - `true` forces the LSM scanner and errors if the table has no
|
|
||||||
* MemWAL write spec. `false` bypasses the MemWAL and reads the base table only,
|
|
||||||
* even when a spec is present.
|
|
||||||
*
|
|
||||||
* Note: the LSM scanner does not support every query shape (e.g. reranking,
|
|
||||||
* hybrid search, `orderBy`). On a MemWAL table those shapes error unless
|
|
||||||
* `useLsm(false)` is set, because a base-only read would silently exclude
|
|
||||||
* un-compacted MemWAL data.
|
|
||||||
*/
|
|
||||||
useLsm(enable: boolean): this {
|
|
||||||
this.doCall((inner: NativeQueryType) => inner.useLsm(enable));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -772,20 +748,6 @@ export class TakeQuery extends QueryBase<NativeTakeQuery> {
|
|||||||
constructor(inner: NativeTakeQuery) {
|
constructor(inner: NativeTakeQuery) {
|
||||||
super(inner);
|
super(inner);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Control MemWAL read routing for this take query.
|
|
||||||
*
|
|
||||||
* `false` bypasses the MemWAL and reads the base table only — the escape hatch,
|
|
||||||
* since take-by-row-id/offset is not supported on the LSM scanner and, on a
|
|
||||||
* MemWAL table, auto-routes to it and errors otherwise.
|
|
||||||
*
|
|
||||||
* @param enable - `false` reads the base table only.
|
|
||||||
*/
|
|
||||||
useLsm(enable: boolean): this {
|
|
||||||
this.doCall((inner: NativeTakeQuery) => inner.useLsm(enable));
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** A builder for LanceDB queries.
|
/** A builder for LanceDB queries.
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ export function sanitizeMetadata(
|
|||||||
throw Error("Expected metadata, if present, to be a Map<string, string>");
|
throw Error("Expected metadata, if present, to be a Map<string, string>");
|
||||||
}
|
}
|
||||||
for (const item of metadataLike) {
|
for (const item of metadataLike) {
|
||||||
if (typeof item[0] !== "string" || typeof item[1] !== "string") {
|
if (!(typeof item[0] === "string" || !(typeof item[1] === "string"))) {
|
||||||
throw Error(
|
throw Error(
|
||||||
"Expected metadata, if present, to be a Map<string, string> but it had non-string keys or values",
|
"Expected metadata, if present, to be a Map<string, string> but it had non-string keys or values",
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-darwin-arm64",
|
"name": "@lancedb/lancedb-darwin-arm64",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["darwin"],
|
"os": ["darwin"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.darwin-arm64.node",
|
"main": "lancedb.darwin-arm64.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-arm64-gnu",
|
"name": "@lancedb/lancedb-linux-arm64-gnu",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.linux-arm64-gnu.node",
|
"main": "lancedb.linux-arm64-gnu.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-arm64-musl",
|
"name": "@lancedb/lancedb-linux-arm64-musl",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["arm64"],
|
"cpu": ["arm64"],
|
||||||
"main": "lancedb.linux-arm64-musl.node",
|
"main": "lancedb.linux-arm64-musl.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-x64-gnu",
|
"name": "@lancedb/lancedb-linux-x64-gnu",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.linux-x64-gnu.node",
|
"main": "lancedb.linux-x64-gnu.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-linux-x64-musl",
|
"name": "@lancedb/lancedb-linux-x64-musl",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["linux"],
|
"os": ["linux"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.linux-x64-musl.node",
|
"main": "lancedb.linux-x64-musl.node",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-win32-arm64-msvc",
|
"name": "@lancedb/lancedb-win32-arm64-msvc",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": [
|
"os": [
|
||||||
"win32"
|
"win32"
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb-win32-x64-msvc",
|
"name": "@lancedb/lancedb-win32-x64-msvc",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"os": ["win32"],
|
"os": ["win32"],
|
||||||
"cpu": ["x64"],
|
"cpu": ["x64"],
|
||||||
"main": "lancedb.win32-x64-msvc.node",
|
"main": "lancedb.win32-x64-msvc.node",
|
||||||
|
|||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@lancedb/lancedb",
|
"name": "@lancedb/lancedb",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@lancedb/lancedb",
|
"name": "@lancedb/lancedb",
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"cpu": [
|
"cpu": [
|
||||||
"x64",
|
"x64",
|
||||||
"arm64"
|
"arm64"
|
||||||
|
|||||||
+1
-1
@@ -11,7 +11,7 @@
|
|||||||
"ann"
|
"ann"
|
||||||
],
|
],
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "0.37.1-beta.0",
|
"version": "0.32.0-beta.2",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": "./dist/index.js",
|
".": "./dist/index.js",
|
||||||
|
|||||||
+3
-13
@@ -43,7 +43,6 @@ pub fn tokenize(
|
|||||||
lower_case: Option<bool>,
|
lower_case: Option<bool>,
|
||||||
stem: Option<bool>,
|
stem: Option<bool>,
|
||||||
remove_stop_words: Option<bool>,
|
remove_stop_words: Option<bool>,
|
||||||
custom_stop_words: Option<Vec<String>>,
|
|
||||||
ascii_folding: Option<bool>,
|
ascii_folding: Option<bool>,
|
||||||
ngram_min_length: Option<u32>,
|
ngram_min_length: Option<u32>,
|
||||||
ngram_max_length: Option<u32>,
|
ngram_max_length: Option<u32>,
|
||||||
@@ -73,7 +72,6 @@ pub fn tokenize(
|
|||||||
if let Some(remove_stop_words) = remove_stop_words {
|
if let Some(remove_stop_words) = remove_stop_words {
|
||||||
opts = opts.remove_stop_words(remove_stop_words);
|
opts = opts.remove_stop_words(remove_stop_words);
|
||||||
}
|
}
|
||||||
opts = opts.custom_stop_words(custom_stop_words);
|
|
||||||
if let Some(ascii_folding) = ascii_folding {
|
if let Some(ascii_folding) = ascii_folding {
|
||||||
opts = opts.ascii_folding(ascii_folding);
|
opts = opts.ascii_folding(ascii_folding);
|
||||||
}
|
}
|
||||||
@@ -224,13 +222,11 @@ impl Index {
|
|||||||
lower_case: Option<bool>,
|
lower_case: Option<bool>,
|
||||||
stem: Option<bool>,
|
stem: Option<bool>,
|
||||||
remove_stop_words: Option<bool>,
|
remove_stop_words: Option<bool>,
|
||||||
custom_stop_words: Option<Vec<String>>,
|
|
||||||
ascii_folding: Option<bool>,
|
ascii_folding: Option<bool>,
|
||||||
ngram_min_length: Option<u32>,
|
ngram_min_length: Option<u32>,
|
||||||
ngram_max_length: Option<u32>,
|
ngram_max_length: Option<u32>,
|
||||||
prefix_only: Option<bool>,
|
prefix_only: Option<bool>,
|
||||||
block_size: Option<u32>,
|
) -> Self {
|
||||||
) -> napi::Result<Self> {
|
|
||||||
let mut opts = FtsIndexBuilder::default();
|
let mut opts = FtsIndexBuilder::default();
|
||||||
if let Some(with_position) = with_position {
|
if let Some(with_position) = with_position {
|
||||||
opts = opts.with_position(with_position);
|
opts = opts.with_position(with_position);
|
||||||
@@ -253,7 +249,6 @@ impl Index {
|
|||||||
if let Some(remove_stop_words) = remove_stop_words {
|
if let Some(remove_stop_words) = remove_stop_words {
|
||||||
opts = opts.remove_stop_words(remove_stop_words);
|
opts = opts.remove_stop_words(remove_stop_words);
|
||||||
}
|
}
|
||||||
opts = opts.custom_stop_words(custom_stop_words);
|
|
||||||
if let Some(ascii_folding) = ascii_folding {
|
if let Some(ascii_folding) = ascii_folding {
|
||||||
opts = opts.ascii_folding(ascii_folding);
|
opts = opts.ascii_folding(ascii_folding);
|
||||||
}
|
}
|
||||||
@@ -266,15 +261,10 @@ impl Index {
|
|||||||
if let Some(prefix_only) = prefix_only {
|
if let Some(prefix_only) = prefix_only {
|
||||||
opts = opts.ngram_prefix_only(prefix_only);
|
opts = opts.ngram_prefix_only(prefix_only);
|
||||||
}
|
}
|
||||||
if let Some(block_size) = block_size {
|
|
||||||
opts = opts
|
|
||||||
.block_size(block_size as usize)
|
|
||||||
.map_err(|err| napi::Error::from_reason(err.to_string()))?;
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(Self {
|
Self {
|
||||||
inner: Mutex::new(Some(LanceDbIndex::FTS(opts))),
|
inner: Mutex::new(Some(LanceDbIndex::FTS(opts))),
|
||||||
})
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(factory)]
|
#[napi(factory)]
|
||||||
|
|||||||
+2
-2
@@ -51,9 +51,9 @@ impl NativeMergeInsertBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
pub fn use_lsm(&self, enable: bool) -> Self {
|
pub fn use_lsm_write(&self, use_lsm_write: bool) -> Self {
|
||||||
let mut this = self.clone();
|
let mut this = self.clone();
|
||||||
this.inner.use_lsm(enable);
|
this.inner.use_lsm_write(use_lsm_write);
|
||||||
this
|
this
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -168,11 +168,6 @@ impl Query {
|
|||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
pub fn order_by(&mut self, ordering: Option<Vec<ColumnOrdering>>) -> napi::Result<()> {
|
pub fn order_by(&mut self, ordering: Option<Vec<ColumnOrdering>>) -> napi::Result<()> {
|
||||||
let ordering = ordering.map(|ordering| {
|
let ordering = ordering.map(|ordering| {
|
||||||
@@ -379,11 +374,6 @@ impl VectorQuery {
|
|||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi]
|
#[napi]
|
||||||
pub fn rerank(
|
pub fn rerank(
|
||||||
&mut self,
|
&mut self,
|
||||||
@@ -489,11 +479,6 @@ impl TakeQuery {
|
|||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi]
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[napi(catch_unwind)]
|
#[napi(catch_unwind)]
|
||||||
pub async fn output_schema(&self) -> napi::Result<Buffer> {
|
pub async fn output_schema(&self) -> napi::Result<Buffer> {
|
||||||
let schema = self.inner.output_schema().await.default_error()?;
|
let schema = self.inner.output_schema().await.default_error()?;
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Manage branches on a LanceDB table: list what exists, create new ones, delete stale ones, and direct read/write operations at a specific branch without touching main. Use for branch lifecycle tasks, experimental/isolated table versions, targeting an operation at a non-main branch, or confirming a mutation did not affect main.
|
Manage branches on a LanceDB table: list what exists, create new ones, delete stale ones, and direct read/write operations at a specific branch without touching main. Use for branch lifecycle tasks, experimental/isolated table versions, targeting an operation at a non-main branch, or confirming a mutation did not affect main.
|
||||||
|
|
||||||
Works on local/OSS and remote Enterprise/Cloud tables, except merging a branch into main, which is Enterprise-only.
|
Works on local/OSS and remote Enterprise/Cloud tables.
|
||||||
|
|
||||||
## The branch model (important)
|
## The branch model (important)
|
||||||
|
|
||||||
@@ -101,69 +101,6 @@ assert b"lancedb:description" not in (table.schema.field("category").metadata or
|
|||||||
|
|
||||||
Two handles on the same branch see each other's writes (e.g. `table.branches.create("exp")` and `db.open_table(name, branch="exp")`); main stays isolated.
|
Two handles on the same branch see each other's writes (e.g. `table.branches.create("exp")` and `db.open_table(name, branch="exp")`); main stays isolated.
|
||||||
|
|
||||||
## Merging a branch into main (Enterprise only)
|
|
||||||
|
|
||||||
Merge is available through the SDKs (`table.branches.merge(...)`) on **Enterprise tables only** — it is not supported on Cloud or local/OSS tables, which raise `NotSupported`.
|
|
||||||
|
|
||||||
`merge` takes the branch to merge **from** and a `dry_run` flag. Both the SDK method and the underlying REST endpoint **actually merge by default** (`dry_run=False`); pass `dry_run=True` to only preview. A rejected merge is **not an exception** — it returns a result with `status="rejected"` rather than raising, so inspect the return value. Use `branches.diff(from_branch)` to inspect a branch's pending diff without attempting a merge.
|
|
||||||
|
|
||||||
```python
|
|
||||||
exp = "experiment-reindex"
|
|
||||||
|
|
||||||
# preview only — returns status="ready" if it would merge cleanly
|
|
||||||
preview = table.branches.merge(exp, dry_run=True)
|
|
||||||
|
|
||||||
# actually merge (default)
|
|
||||||
result = table.branches.merge(exp)
|
|
||||||
if result["status"] == "merged":
|
|
||||||
print("landed at", result["mainVersionAfter"])
|
|
||||||
elif result["status"] == "rejected":
|
|
||||||
print(result["diff"]["mergeBlockers"]) # why it was refused
|
|
||||||
|
|
||||||
# inspect a branch's pending diff without merging
|
|
||||||
diff = table.branches.diff(exp)
|
|
||||||
```
|
|
||||||
|
|
||||||
Async: `await table.branches.merge(exp)`, `await table.branches.diff(exp)`.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const branches = await table.branches();
|
|
||||||
const exp = "experiment-reindex";
|
|
||||||
|
|
||||||
// preview only (second arg is dryRun)
|
|
||||||
const preview = await branches.merge(exp, true);
|
|
||||||
|
|
||||||
// actually merge (default)
|
|
||||||
const result = await branches.merge(exp);
|
|
||||||
if (result.status === "merged") {
|
|
||||||
console.log("landed at", result.mainVersionAfter);
|
|
||||||
} else if (result.status === "rejected") {
|
|
||||||
console.log(result.diff.mergeBlockers);
|
|
||||||
}
|
|
||||||
|
|
||||||
const diff = await branches.diff(exp);
|
|
||||||
```
|
|
||||||
|
|
||||||
The result is the wire JSON, containing `status` (`ready` on a passing dry run, `merged` on success, `rejected` when refused — also `notImplemented`/`unknown`), the branch `diff` (including `mergeBlockers` explaining any rejection), a `preview` of the columns that would be promoted, and — after a real merge — `mainVersionAfter`.
|
|
||||||
|
|
||||||
### Merge preconditions
|
|
||||||
|
|
||||||
Merge only **promotes newly added columns** onto main; it does not replay arbitrary commits. Practically, a branch is mergeable only if it has **exactly one commit since it was created, and that commit added a column**. The merge is rejected (`status: "rejected"`, with `mergeBlockers` set) if:
|
|
||||||
|
|
||||||
- the branch was forked from another branch rather than directly from main
|
|
||||||
- main has advanced since the branch was forked
|
|
||||||
- the branch's rows changed since the fork (row counts must match main exactly)
|
|
||||||
- the branch removed columns or changed a column's type/nullability
|
|
||||||
- the branch added no columns (index-only changes are not merged)
|
|
||||||
|
|
||||||
### Adding a column in a single commit
|
|
||||||
|
|
||||||
Because the branch must contain just one column-adding commit, add the column with its values in one operation rather than add-then-backfill:
|
|
||||||
|
|
||||||
1. **SQL transformation** — `add_columns` with a SQL expression computed from existing columns, so the column lands populated in one commit.
|
|
||||||
2. **Precompute the values** — compute the column's values externally, then add the fully-populated column in a single operation (e.g. via `merge_insert`/`add_columns` with the data ready).
|
|
||||||
3. **Lance-format-level data evolution (pylance)** — use Lance's data evolution with backfill, documented at <https://lance.org/guide/data_evolution/#with-data-backfill>.
|
|
||||||
|
|
||||||
## Quick reference
|
## Quick reference
|
||||||
|
|
||||||
| Goal | Python | TypeScript |
|
| Goal | Python | TypeScript |
|
||||||
@@ -176,7 +113,5 @@ Because the branch must contain just one column-adding commit, add the column wi
|
|||||||
| Delete branch | `table.branches.delete(name)` | `await branches.delete(name)` |
|
| Delete branch | `table.branches.delete(name)` | `await branches.delete(name)` |
|
||||||
| Which branch is this handle on? | `table.current_branch()` (`None` = main) | `table.currentBranch()` (`null` = main) |
|
| Which branch is this handle on? | `table.current_branch()` (`None` = main) | `table.currentBranch()` (`null` = main) |
|
||||||
| Target main | use the original (non-branch) handle | use the original (non-branch) handle |
|
| Target main | use the original (non-branch) handle | use the original (non-branch) handle |
|
||||||
| Merge branch into main (Enterprise only) | `table.branches.merge(from_branch, dry_run=False)` | `await branches.merge(fromBranch, dryRun)` |
|
|
||||||
| Preview a branch's pending diff (Enterprise only) | `table.branches.diff(from_branch)` | `await branches.diff(fromBranch)` |
|
|
||||||
|
|
||||||
Branch names must be non-empty; empty names raise a validation error.
|
Branch names must be non-empty; empty names raise a validation error.
|
||||||
|
|||||||
@@ -4,19 +4,12 @@ Quick method reference for Python LanceDB code. Cross-check source for non-trivi
|
|||||||
|
|
||||||
## Connect
|
## Connect
|
||||||
|
|
||||||
If you're connecting to a remote database, use this:
|
|
||||||
```python
|
```python
|
||||||
import lancedb
|
import lancedb
|
||||||
|
|
||||||
db = lancedb.connect("db://my-db", api_key=api_key, host_override=host_override) # remote
|
db = lancedb.connect("./camelot-db") # local/OSS
|
||||||
|
db = lancedb.connect("db://my-db", api_key=api_key, region=region) # remote
|
||||||
```
|
```
|
||||||
(values may be found in LANCEDB_API_KEY and LANCEDB_HOST_OVERRIDE, either in env vars or a .env file)
|
|
||||||
|
|
||||||
If you're connecting to a local table using OSS LanceDB, use this:
|
|
||||||
```python
|
|
||||||
db = lancedb.connect("./camelot-db") # local/OSS
|
|
||||||
```
|
|
||||||
If you're not sure which, or if you can't find the api_key or host_override params, ask the user.
|
|
||||||
|
|
||||||
**Place the local database directory next to the script/entrypoint that opens it** (i.e. resolve the path relative to the script, `Path(__file__).parent / "camelot-db"`), not buried under a shared `data/` folder. The Lance dataset is the database, not a data file — keeping it beside its code makes ownership obvious and paths stable regardless of the working directory the script is launched from.
|
**Place the local database directory next to the script/entrypoint that opens it** (i.e. resolve the path relative to the script, `Path(__file__).parent / "camelot-db"`), not buried under a shared `data/` folder. The Lance dataset is the database, not a data file — keeping it beside its code makes ownership obvious and paths stable regardless of the working directory the script is launched from.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
[tool.bumpversion]
|
||||||
|
current_version = "0.35.0-beta.2"
|
||||||
|
parse = """(?x)
|
||||||
|
(?P<major>0|[1-9]\\d*)\\.
|
||||||
|
(?P<minor>0|[1-9]\\d*)\\.
|
||||||
|
(?P<patch>0|[1-9]\\d*)
|
||||||
|
(?:-(?P<pre_l>[a-zA-Z-]+)\\.(?P<pre_n>0|[1-9]\\d*))?
|
||||||
|
"""
|
||||||
|
serialize = [
|
||||||
|
"{major}.{minor}.{patch}-{pre_l}.{pre_n}",
|
||||||
|
"{major}.{minor}.{patch}",
|
||||||
|
]
|
||||||
|
search = "{current_version}"
|
||||||
|
replace = "{new_version}"
|
||||||
|
regex = false
|
||||||
|
ignore_missing_version = false
|
||||||
|
ignore_missing_files = false
|
||||||
|
tag = true
|
||||||
|
sign_tags = false
|
||||||
|
tag_name = "python-v{new_version}"
|
||||||
|
tag_message = "Bump version: {current_version} → {new_version}"
|
||||||
|
allow_dirty = true
|
||||||
|
commit = true
|
||||||
|
message = "Bump version: {current_version} → {new_version}"
|
||||||
|
commit_args = ""
|
||||||
|
# bump-my-version >=1.4.0 rejects pre_commit_hooks containing shell syntax unless opted in.
|
||||||
|
allow_shell_hooks = true
|
||||||
|
|
||||||
|
# Update Cargo.lock after version bump
|
||||||
|
pre_commit_hooks = [
|
||||||
|
"""
|
||||||
|
cd python && cargo update -p lancedb-python
|
||||||
|
if git diff --quiet ../Cargo.lock; then
|
||||||
|
echo "Cargo.lock unchanged"
|
||||||
|
else
|
||||||
|
git add ../Cargo.lock
|
||||||
|
echo "Updated and staged Cargo.lock"
|
||||||
|
fi
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
[tool.bumpversion.parts.pre_l]
|
||||||
|
values = ["beta", "final"]
|
||||||
|
optional_value = "final"
|
||||||
|
|
||||||
|
[[tool.bumpversion.files]]
|
||||||
|
filename = "Cargo.toml"
|
||||||
|
search = "\nversion = \"{current_version}\""
|
||||||
|
replace = "\nversion = \"{new_version}\""
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "lancedb-python"
|
name = "lancedb-python"
|
||||||
version = "0.37.1-beta.0"
|
version = "0.35.0-beta.2"
|
||||||
publish = false
|
publish = false
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
description = "Python bindings for LanceDB"
|
description = "Python bindings for LanceDB"
|
||||||
|
|||||||
@@ -258,7 +258,6 @@ def tokenize(
|
|||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = True,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = True,
|
||||||
custom_stop_words: Optional[List[str]] = None,
|
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = True,
|
||||||
ngram_min_length: int = 3,
|
ngram_min_length: int = 3,
|
||||||
ngram_max_length: int = 3,
|
ngram_max_length: int = 3,
|
||||||
@@ -266,10 +265,9 @@ def tokenize(
|
|||||||
) -> Iterable[FtsToken]:
|
) -> Iterable[FtsToken]:
|
||||||
"""Tokenize a full-text search query using an explicit tokenizer.
|
"""Tokenize a full-text search query using an explicit tokenizer.
|
||||||
|
|
||||||
This does not require an FTS index. The tokenizer options match
|
This does not require a table or FTS index. The tokenizer options match
|
||||||
:class:`lancedb.index.FTS`. ``custom_stop_words`` accepts a list of strings.
|
:class:`lancedb.index.FTS`.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return _tokenize(
|
return _tokenize(
|
||||||
query,
|
query,
|
||||||
base_tokenizer=base_tokenizer,
|
base_tokenizer=base_tokenizer,
|
||||||
@@ -278,7 +276,6 @@ def tokenize(
|
|||||||
lower_case=lower_case,
|
lower_case=lower_case,
|
||||||
stem=stem,
|
stem=stem,
|
||||||
remove_stop_words=remove_stop_words,
|
remove_stop_words=remove_stop_words,
|
||||||
custom_stop_words=custom_stop_words,
|
|
||||||
ascii_folding=ascii_folding,
|
ascii_folding=ascii_folding,
|
||||||
ngram_min_length=ngram_min_length,
|
ngram_min_length=ngram_min_length,
|
||||||
ngram_max_length=ngram_max_length,
|
ngram_max_length=ngram_max_length,
|
||||||
|
|||||||
@@ -59,7 +59,6 @@ def tokenize(
|
|||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = True,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = True,
|
||||||
custom_stop_words: Optional[List[str]] = None,
|
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = True,
|
||||||
ngram_min_length: int = 3,
|
ngram_min_length: int = 3,
|
||||||
ngram_max_length: int = 3,
|
ngram_max_length: int = 3,
|
||||||
@@ -298,11 +297,6 @@ class Table:
|
|||||||
async def fetch_blobs(
|
async def fetch_blobs(
|
||||||
self, column: str, row_ids: list[int]
|
self, column: str, row_ids: list[int]
|
||||||
) -> pa.LargeBinaryArray: ...
|
) -> pa.LargeBinaryArray: ...
|
||||||
async def fetch_blob_ranges(
|
|
||||||
self,
|
|
||||||
column: str,
|
|
||||||
requests: List[Tuple[int, int, int]],
|
|
||||||
) -> pa.LargeBinaryArray: ...
|
|
||||||
async def fetch_blob_files(
|
async def fetch_blob_files(
|
||||||
self, column: str, row_ids: list[int]
|
self, column: str, row_ids: list[int]
|
||||||
) -> list[Optional[BlobFile]]: ...
|
) -> list[Optional[BlobFile]]: ...
|
||||||
@@ -397,7 +391,6 @@ class Query:
|
|||||||
def fast_search(self): ...
|
def fast_search(self): ...
|
||||||
def with_row_id(self): ...
|
def with_row_id(self): ...
|
||||||
def postfilter(self): ...
|
def postfilter(self): ...
|
||||||
def use_lsm(self, enable: bool): ...
|
|
||||||
def nearest_to(self, query_vec: pa.Array) -> VectorQuery: ...
|
def nearest_to(self, query_vec: pa.Array) -> VectorQuery: ...
|
||||||
def nearest_to_text(self, query: dict) -> FTSQuery: ...
|
def nearest_to_text(self, query: dict) -> FTSQuery: ...
|
||||||
def order_by(self, ordering: Optional[List[ColumnOrdering]]): ...
|
def order_by(self, ordering: Optional[List[ColumnOrdering]]): ...
|
||||||
@@ -414,7 +407,6 @@ class Query:
|
|||||||
class TakeQuery:
|
class TakeQuery:
|
||||||
def select(self, columns: List[str]): ...
|
def select(self, columns: List[str]): ...
|
||||||
def with_row_id(self): ...
|
def with_row_id(self): ...
|
||||||
def use_lsm(self, enable: bool): ...
|
|
||||||
async def output_schema(self) -> pa.Schema: ...
|
async def output_schema(self) -> pa.Schema: ...
|
||||||
async def execute(self) -> RecordBatchStream: ...
|
async def execute(self) -> RecordBatchStream: ...
|
||||||
async def explain_plan(self, verbose: Optional[bool]) -> str: ...
|
async def explain_plan(self, verbose: Optional[bool]) -> str: ...
|
||||||
@@ -433,7 +425,6 @@ class FTSQuery:
|
|||||||
def fast_search(self): ...
|
def fast_search(self): ...
|
||||||
def with_row_id(self): ...
|
def with_row_id(self): ...
|
||||||
def postfilter(self): ...
|
def postfilter(self): ...
|
||||||
def use_lsm(self, enable: bool): ...
|
|
||||||
def get_query(self) -> str: ...
|
def get_query(self) -> str: ...
|
||||||
def add_query_vector(self, query_vec: pa.Array) -> None: ...
|
def add_query_vector(self, query_vec: pa.Array) -> None: ...
|
||||||
def nearest_to(self, query_vec: pa.Array) -> HybridQuery: ...
|
def nearest_to(self, query_vec: pa.Array) -> HybridQuery: ...
|
||||||
@@ -461,7 +452,6 @@ class VectorQuery:
|
|||||||
def column(self, column: str): ...
|
def column(self, column: str): ...
|
||||||
def distance_type(self, distance_type: str): ...
|
def distance_type(self, distance_type: str): ...
|
||||||
def postfilter(self): ...
|
def postfilter(self): ...
|
||||||
def use_lsm(self, enable: bool): ...
|
|
||||||
def refine_factor(self, refine_factor: int): ...
|
def refine_factor(self, refine_factor: int): ...
|
||||||
def nprobes(self, nprobes: int): ...
|
def nprobes(self, nprobes: int): ...
|
||||||
def minimum_nprobes(self, minimum_nprobes: int): ...
|
def minimum_nprobes(self, minimum_nprobes: int): ...
|
||||||
@@ -485,7 +475,6 @@ class HybridQuery:
|
|||||||
def fast_search(self): ...
|
def fast_search(self): ...
|
||||||
def with_row_id(self): ...
|
def with_row_id(self): ...
|
||||||
def postfilter(self): ...
|
def postfilter(self): ...
|
||||||
def use_lsm(self, enable: bool): ...
|
|
||||||
def distance_type(self, distance_type: str): ...
|
def distance_type(self, distance_type: str): ...
|
||||||
def refine_factor(self, refine_factor: int): ...
|
def refine_factor(self, refine_factor: int): ...
|
||||||
def nprobes(self, nprobes: int): ...
|
def nprobes(self, nprobes: int): ...
|
||||||
@@ -510,7 +499,6 @@ class PyQueryRequest:
|
|||||||
select: Optional[Union[str, List[str]]]
|
select: Optional[Union[str, List[str]]]
|
||||||
fast_search: Optional[bool]
|
fast_search: Optional[bool]
|
||||||
with_row_id: Optional[bool]
|
with_row_id: Optional[bool]
|
||||||
use_lsm: Optional[bool]
|
|
||||||
column: Optional[str]
|
column: Optional[str]
|
||||||
query_vector: Optional[List[pa.Array]]
|
query_vector: Optional[List[pa.Array]]
|
||||||
minimum_nprobes: Optional[int]
|
minimum_nprobes: Optional[int]
|
||||||
|
|||||||
@@ -359,7 +359,7 @@ class DBConnection(EnforceOverrides):
|
|||||||
|
|
||||||
Data is converted to Arrow before being written to disk. For maximum
|
Data is converted to Arrow before being written to disk. For maximum
|
||||||
control over how data is saved, either provide the PyArrow schema to
|
control over how data is saved, either provide the PyArrow schema to
|
||||||
convert to or else provide a [PyArrow Table][pyarrow.Table] directly.
|
convert to or else provide a [PyArrow Table](pyarrow.Table) directly.
|
||||||
|
|
||||||
>>> import pyarrow as pa
|
>>> import pyarrow as pa
|
||||||
>>> custom_schema = pa.schema([
|
>>> custom_schema = pa.schema([
|
||||||
@@ -1529,7 +1529,7 @@ class AsyncConnection(object):
|
|||||||
|
|
||||||
Data is converted to Arrow before being written to disk. For maximum
|
Data is converted to Arrow before being written to disk. For maximum
|
||||||
control over how data is saved, either provide the PyArrow schema to
|
control over how data is saved, either provide the PyArrow schema to
|
||||||
convert to or else provide a [PyArrow Table][pyarrow.Table] directly.
|
convert to or else provide a [PyArrow Table](pyarrow.Table) directly.
|
||||||
|
|
||||||
>>> import pyarrow as pa
|
>>> import pyarrow as pa
|
||||||
>>> custom_schema = pa.schema([
|
>>> custom_schema = pa.schema([
|
||||||
|
|||||||
@@ -21,32 +21,3 @@ from .watsonx import WatsonxEmbeddings
|
|||||||
from .voyageai import VoyageAIEmbeddingFunction
|
from .voyageai import VoyageAIEmbeddingFunction
|
||||||
from .colpali import ColPaliEmbeddings
|
from .colpali import ColPaliEmbeddings
|
||||||
from .siglip import SigLipEmbeddings
|
from .siglip import SigLipEmbeddings
|
||||||
|
|
||||||
# The API reference renders this package with a single mkdocstrings directive,
|
|
||||||
# which only picks up names listed here. New embedding functions must be added
|
|
||||||
# to both the imports above and this list, or they will silently go undocumented.
|
|
||||||
__all__ = [
|
|
||||||
"EmbeddingFunction",
|
|
||||||
"EmbeddingFunctionConfig",
|
|
||||||
"TextEmbeddingFunction",
|
|
||||||
"EmbeddingFunctionRegistry",
|
|
||||||
"get_registry",
|
|
||||||
"register",
|
|
||||||
"SentenceTransformerEmbeddings",
|
|
||||||
"OpenAIEmbeddings",
|
|
||||||
"OpenClipEmbeddings",
|
|
||||||
"BedRockText",
|
|
||||||
"CohereEmbeddingFunction",
|
|
||||||
"GeminiText",
|
|
||||||
"GteEmbeddings",
|
|
||||||
"InstructorEmbeddingFunction",
|
|
||||||
"JinaEmbeddings",
|
|
||||||
"OllamaEmbeddings",
|
|
||||||
"TransformersEmbeddingFunction",
|
|
||||||
"ColbertEmbeddings",
|
|
||||||
"VoyageAIEmbeddingFunction",
|
|
||||||
"WatsonxEmbeddings",
|
|
||||||
"ColPaliEmbeddings",
|
|
||||||
"ImageBindEmbeddings",
|
|
||||||
"SigLipEmbeddings",
|
|
||||||
]
|
|
||||||
|
|||||||
@@ -21,20 +21,20 @@ class BedRockText(TextEmbeddingFunction):
|
|||||||
"""
|
"""
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "amazon.titan-embed-text-v1"
|
name: str, default "amazon.titan-embed-text-v1"
|
||||||
The model ID of the bedrock model to use. Supported models for are:
|
The model ID of the bedrock model to use. Supported models for are:
|
||||||
- amazon.titan-embed-text-v1
|
- amazon.titan-embed-text-v1
|
||||||
- cohere.embed-english-v3
|
- cohere.embed-english-v3
|
||||||
- cohere.embed-multilingual-v3
|
- cohere.embed-multilingual-v3
|
||||||
region : str, default "us-east-1"
|
region: str, default "us-east-1"
|
||||||
Optional name of the AWS Region in which the service should be called.
|
Optional name of the AWS Region in which the service should be called.
|
||||||
profile_name : str, default None
|
profile_name: str, default None
|
||||||
Optional name of the AWS profile to use for calling the Bedrock service.
|
Optional name of the AWS profile to use for calling the Bedrock service.
|
||||||
If not specified, the default profile will be used.
|
If not specified, the default profile will be used.
|
||||||
assumed_role : str, default None
|
assumed_role: str, default None
|
||||||
Optional ARN of an AWS IAM role to assume for calling the Bedrock service.
|
Optional ARN of an AWS IAM role to assume for calling the Bedrock service.
|
||||||
If not specified, the current active credentials will be used.
|
If not specified, the current active credentials will be used.
|
||||||
role_session_name : str, default "lancedb-embeddings"
|
role_session_name: str, default "lancedb-embeddings"
|
||||||
Optional name of the AWS IAM role session to use for calling the Bedrock
|
Optional name of the AWS IAM role session to use for calling the Bedrock
|
||||||
service. If not specified, "lancedb-embeddings" name will be used.
|
service. If not specified, "lancedb-embeddings" name will be used.
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ class CohereEmbeddingFunction(TextEmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "embed-multilingual-v2.0"
|
name: str, default "embed-multilingual-v2.0"
|
||||||
The name of the model to use. List of acceptable models:
|
The name of the model to use. List of acceptable models:
|
||||||
|
|
||||||
* embed-english-v3.0
|
* embed-english-v3.0
|
||||||
@@ -33,14 +33,12 @@ class CohereEmbeddingFunction(TextEmbeddingFunction):
|
|||||||
* embed-english-light-v2.0
|
* embed-english-light-v2.0
|
||||||
* embed-multilingual-v2.0
|
* embed-multilingual-v2.0
|
||||||
|
|
||||||
source_input_type : str, default "search_document"
|
source_input_type: str, default "search_document"
|
||||||
The input type for the source column in the database
|
The input type for the source column in the database
|
||||||
|
|
||||||
query_input_type : str, default "search_query"
|
query_input_type: str, default "search_query"
|
||||||
The input type for the query column in the database
|
The input type for the query column in the database
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
Cohere supports following input types:
|
Cohere supports following input types:
|
||||||
|
|
||||||
| Input Type | Description |
|
| Input Type | Description |
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ class ColPaliEmbeddings(EmbeddingFunction):
|
|||||||
The token pooling strategy to use, by default "hierarchical".
|
The token pooling strategy to use, by default "hierarchical".
|
||||||
- "hierarchical": Progressively pools tokens to reduce sequence length.
|
- "hierarchical": Progressively pools tokens to reduce sequence length.
|
||||||
- "lambda": A simpler pooling that uses a custom `pooling_func`.
|
- "lambda": A simpler pooling that uses a custom `pooling_func`.
|
||||||
pooling_func : typing.Callable, optional
|
pooling_func: typing.Callable, optional
|
||||||
A function to use for pooling when `pooling_strategy` is "lambda".
|
A function to use for pooling when `pooling_strategy` is "lambda".
|
||||||
pool_factor : int
|
pool_factor : int
|
||||||
Factor to reduce sequence length if token pooling is enabled (default 2).
|
Factor to reduce sequence length if token pooling is enabled (default 2).
|
||||||
@@ -52,7 +52,7 @@ class ColPaliEmbeddings(EmbeddingFunction):
|
|||||||
Quantization configuration for the model. (default None, bitsandbytes needed)
|
Quantization configuration for the model. (default None, bitsandbytes needed)
|
||||||
batch_size : int
|
batch_size : int
|
||||||
Batch size for processing inputs (default 2).
|
Batch size for processing inputs (default 2).
|
||||||
offload_folder : str, optional
|
offload_folder: str, optional
|
||||||
Folder to offload model weights if using CPU offloading (default None). This is
|
Folder to offload model weights if using CPU offloading (default None). This is
|
||||||
useful for large models that do not fit in memory.
|
useful for large models that do not fit in memory.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -48,16 +48,16 @@ class GeminiText(TextEmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "gemini-embedding-001"
|
name: str, default "gemini-embedding-001"
|
||||||
The name of the model to use. Supported models include:
|
The name of the model to use. Supported models include:
|
||||||
- "gemini-embedding-001" (768 dimensions)
|
- "gemini-embedding-001" (768 dimensions)
|
||||||
|
|
||||||
Note: The legacy "models/embedding-001" format is also supported but
|
Note: The legacy "models/embedding-001" format is also supported but
|
||||||
"gemini-embedding-001" is recommended.
|
"gemini-embedding-001" is recommended.
|
||||||
|
|
||||||
query_task_type : str, default "retrieval_query"
|
query_task_type: str, default "retrieval_query"
|
||||||
Sets the task type for the queries.
|
Sets the task type for the queries.
|
||||||
source_task_type : str, default "retrieval_document"
|
source_task_type: str, default "retrieval_document"
|
||||||
Sets the task type for ingestion.
|
Sets the task type for ingestion.
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
|
|||||||
@@ -26,13 +26,13 @@ class GteEmbeddings(TextEmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "thenlper/gte-large"
|
name: str, default "thenlper/gte-large"
|
||||||
The name of the model to use.
|
The name of the model to use.
|
||||||
device : str, default "cpu"
|
device: str, default "cpu"
|
||||||
Sets the device type for the model.
|
Sets the device type for the model.
|
||||||
normalize : str, default "True"
|
normalize: str, default "True"
|
||||||
Controls normalize param in encode function for the transformer.
|
Controls normalize param in encode function for the transformer.
|
||||||
mlx : bool, default False
|
mlx: bool, default False
|
||||||
Controls which model to use. False for gte-large,True for the mlx version.
|
Controls which model to use. False for gte-large,True for the mlx version.
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
|
|||||||
@@ -35,23 +35,23 @@ class InstructorEmbeddingFunction(TextEmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str
|
name: str
|
||||||
The name of the model to use. Available models are listed at
|
The name of the model to use. Available models are listed at
|
||||||
https://github.com/xlang-ai/instructor-embedding#model-list;
|
https://github.com/xlang-ai/instructor-embedding#model-list;
|
||||||
The default model is hkunlp/instructor-base
|
The default model is hkunlp/instructor-base
|
||||||
batch_size : int, default 32
|
batch_size: int, default 32
|
||||||
The batch size to use when generating embeddings
|
The batch size to use when generating embeddings
|
||||||
device : str, default "cpu"
|
device: str, default "cpu"
|
||||||
The device to use when generating embeddings
|
The device to use when generating embeddings
|
||||||
show_progress_bar : bool, default True
|
show_progress_bar: bool, default True
|
||||||
Whether to show a progress bar when generating embeddings
|
Whether to show a progress bar when generating embeddings
|
||||||
normalize_embeddings : bool, default True
|
normalize_embeddings: bool, default True
|
||||||
Whether to normalize the embeddings
|
Whether to normalize the embeddings
|
||||||
quantize : bool, default False
|
quantize: bool, default False
|
||||||
Whether to quantize the model
|
Whether to quantize the model
|
||||||
source_instruction : str, default "represent the document for retrieval"
|
source_instruction: str, default "represent the document for retrieval"
|
||||||
The instruction for the source column
|
The instruction for the source column
|
||||||
query_instruction : str, default "represent the document for retrieving the most
|
query_instruction: str, default "represent the document for retrieving the most
|
||||||
similar documents"
|
similar documents"
|
||||||
The instruction for the query
|
The instruction for the query
|
||||||
|
|
||||||
|
|||||||
@@ -40,10 +40,10 @@ class JinaEmbeddings(EmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "jina-clip-v1". Note that some models support both image
|
name: str, default "jina-clip-v1". Note that some models support both image
|
||||||
and text embeddings and some just text embedding
|
and text embeddings and some just text embedding
|
||||||
|
|
||||||
api_key : str, default None
|
api_key: str, default None
|
||||||
The api key to access Jina API. If you pass None, you can set JINA_API_KEY
|
The api key to access Jina API. If you pass None, you can set JINA_API_KEY
|
||||||
environment variable
|
environment variable
|
||||||
|
|
||||||
|
|||||||
@@ -21,13 +21,13 @@ class SentenceTransformerEmbeddings(TextEmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str, default "all-MiniLM-L6-v2"
|
name: str, default "all-MiniLM-L6-v2"
|
||||||
The name of the model to use.
|
The name of the model to use.
|
||||||
device : str, default "cpu"
|
device: str, default "cpu"
|
||||||
The device to use for the model
|
The device to use for the model
|
||||||
normalize : bool, default True
|
normalize: bool, default True
|
||||||
Whether to normalize the embeddings
|
Whether to normalize the embeddings
|
||||||
trust_remote_code : bool, default True
|
trust_remote_code: bool, default True
|
||||||
Whether to trust the remote code
|
Whether to trust the remote code
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|||||||
@@ -167,7 +167,7 @@ class VoyageAIEmbeddingFunction(EmbeddingFunction):
|
|||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
name : str
|
name: str
|
||||||
The name of the model to use. List of acceptable models:
|
The name of the model to use. List of acceptable models:
|
||||||
|
|
||||||
* voyage-4 (1024 dims, general-purpose and multilingual retrieval)
|
* voyage-4 (1024 dims, general-purpose and multilingual retrieval)
|
||||||
@@ -185,7 +185,7 @@ class VoyageAIEmbeddingFunction(EmbeddingFunction):
|
|||||||
* voyage-law-2
|
* voyage-law-2
|
||||||
* voyage-code-2
|
* voyage-code-2
|
||||||
|
|
||||||
output_dimension : int, optional
|
output_dimension: int, optional
|
||||||
The output dimension for models that support flexible dimensions.
|
The output dimension for models that support flexible dimensions.
|
||||||
Currently only voyage-multimodal-3.5 supports this feature.
|
Currently only voyage-multimodal-3.5 supports this feature.
|
||||||
Valid options: 256, 512, 1024 (default), 2048.
|
Valid options: 256, 512, 1024 (default), 2048.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
|
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from typing import List, Literal, Optional
|
from typing import Literal, Optional
|
||||||
|
|
||||||
from ._lancedb import (
|
from ._lancedb import (
|
||||||
IndexConfig,
|
IndexConfig,
|
||||||
@@ -115,12 +115,6 @@ class FTS:
|
|||||||
|
|
||||||
For example, it works with `title`, `description`, `content`, etc.
|
For example, it works with `title`, `description`, `content`, etc.
|
||||||
|
|
||||||
Examples
|
|
||||||
--------
|
|
||||||
Create an index configuration that uses 256-document posting blocks:
|
|
||||||
|
|
||||||
>>> config = FTS(block_size=256)
|
|
||||||
|
|
||||||
Attributes
|
Attributes
|
||||||
----------
|
----------
|
||||||
with_position : bool, default False
|
with_position : bool, default False
|
||||||
@@ -151,18 +145,9 @@ class FTS:
|
|||||||
remove_stop_words : bool, default True
|
remove_stop_words : bool, default True
|
||||||
Whether to remove stop words. Stop words are common words that are often
|
Whether to remove stop words. Stop words are common words that are often
|
||||||
removed from text before indexing. For example, in English "the" and "and".
|
removed from text before indexing. For example, in English "the" and "and".
|
||||||
custom_stop_words : list of str, optional
|
|
||||||
Custom words replace the built-in language stop words
|
|
||||||
and only take effect when ``remove_stop_words`` is True. ``None`` uses
|
|
||||||
the built-in language list, while an empty list explicitly uses no
|
|
||||||
stop words.
|
|
||||||
ascii_folding : bool, default True
|
ascii_folding : bool, default True
|
||||||
Whether to fold ASCII characters. This converts accented characters to
|
Whether to fold ASCII characters. This converts accented characters to
|
||||||
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
||||||
block_size : int, default 128
|
|
||||||
The number of documents per compressed posting block. Supported values
|
|
||||||
are 128 and 256. A value of 256 uses the experimental FTS V3 format
|
|
||||||
and may introduce breaking changes.
|
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
@@ -183,8 +168,6 @@ class FTS:
|
|||||||
ngram_min_length: int = 3
|
ngram_min_length: int = 3
|
||||||
ngram_max_length: int = 3
|
ngram_max_length: int = 3
|
||||||
prefix_only: bool = False
|
prefix_only: bool = False
|
||||||
block_size: int = 128
|
|
||||||
custom_stop_words: Optional[List[str]] = None
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@@ -219,7 +202,7 @@ class HnswPq:
|
|||||||
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
||||||
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
||||||
|
|
||||||
num_partitions: int, default sqrt(num_rows)
|
num_partitions, default sqrt(num_rows)
|
||||||
|
|
||||||
The number of IVF partitions to create.
|
The number of IVF partitions to create.
|
||||||
|
|
||||||
@@ -228,7 +211,7 @@ class HnswPq:
|
|||||||
will require too much memory. Each partition becomes its own HNSW graph, so
|
will require too much memory. Each partition becomes its own HNSW graph, so
|
||||||
setting this value higher reduces the peak memory use of training.
|
setting this value higher reduces the peak memory use of training.
|
||||||
|
|
||||||
num_sub_vectors: int, default is vector dimension / 16
|
num_sub_vectors, default is vector dimension / 16
|
||||||
|
|
||||||
Number of sub-vectors of PQ.
|
Number of sub-vectors of PQ.
|
||||||
|
|
||||||
@@ -244,13 +227,13 @@ class HnswPq:
|
|||||||
If the dimension is not visible by 8 then we use 1 subvector. This is not
|
If the dimension is not visible by 8 then we use 1 subvector. This is not
|
||||||
ideal and will likely result in poor performance.
|
ideal and will likely result in poor performance.
|
||||||
|
|
||||||
num_bits: int, default 8
|
num_bits: int, default 8
|
||||||
Number of bits to encode each sub-vector.
|
Number of bits to encode each sub-vector.
|
||||||
|
|
||||||
This value controls how much the sub-vectors are compressed. The more bits
|
This value controls how much the sub-vectors are compressed. The more bits
|
||||||
the more accurate the index but the slower search. Only 4 and 8 are supported.
|
the more accurate the index but the slower search. Only 4 and 8 are supported.
|
||||||
|
|
||||||
max_iterations: int, default 50
|
max_iterations, default 50
|
||||||
|
|
||||||
Max iterations to train kmeans.
|
Max iterations to train kmeans.
|
||||||
|
|
||||||
@@ -263,7 +246,7 @@ class HnswPq:
|
|||||||
those cases it is unlikely that setting this larger will lead to the index
|
those cases it is unlikely that setting this larger will lead to the index
|
||||||
converging anyways.
|
converging anyways.
|
||||||
|
|
||||||
sample_rate: int, default 256
|
sample_rate, default 256
|
||||||
|
|
||||||
The rate used to calculate the number of training vectors for kmeans.
|
The rate used to calculate the number of training vectors for kmeans.
|
||||||
|
|
||||||
@@ -279,14 +262,14 @@ class HnswPq:
|
|||||||
Increasing this value might improve the quality of the index but in
|
Increasing this value might improve the quality of the index but in
|
||||||
most cases the default should be sufficient.
|
most cases the default should be sufficient.
|
||||||
|
|
||||||
m: int, default 20
|
m, default 20
|
||||||
|
|
||||||
The number of neighbors to select for each vector in the HNSW graph.
|
The number of neighbors to select for each vector in the HNSW graph.
|
||||||
|
|
||||||
This value controls the tradeoff between search speed and accuracy.
|
This value controls the tradeoff between search speed and accuracy.
|
||||||
The higher the value the more accurate the search but the slower it will be.
|
The higher the value the more accurate the search but the slower it will be.
|
||||||
|
|
||||||
ef_construction: int, default 300
|
ef_construction, default 300
|
||||||
|
|
||||||
The number of candidates to evaluate during the construction of the HNSW graph.
|
The number of candidates to evaluate during the construction of the HNSW graph.
|
||||||
|
|
||||||
@@ -297,7 +280,7 @@ class HnswPq:
|
|||||||
This value should be set to a value that is not less than `ef` in the
|
This value should be set to a value that is not less than `ef` in the
|
||||||
search phase.
|
search phase.
|
||||||
|
|
||||||
target_partition_size: int, default is 1,048,576
|
target_partition_size, default is 1,048,576
|
||||||
|
|
||||||
The target size of each partition.
|
The target size of each partition.
|
||||||
|
|
||||||
@@ -351,7 +334,7 @@ class HnswSq:
|
|||||||
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
||||||
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
||||||
|
|
||||||
num_partitions: int, default sqrt(num_rows)
|
num_partitions, default sqrt(num_rows)
|
||||||
|
|
||||||
The number of IVF partitions to create.
|
The number of IVF partitions to create.
|
||||||
|
|
||||||
@@ -360,7 +343,7 @@ class HnswSq:
|
|||||||
will require too much memory. Each partition becomes its own HNSW graph, so
|
will require too much memory. Each partition becomes its own HNSW graph, so
|
||||||
setting this value higher reduces the peak memory use of training.
|
setting this value higher reduces the peak memory use of training.
|
||||||
|
|
||||||
max_iterations: int, default 50
|
max_iterations, default 50
|
||||||
|
|
||||||
Max iterations to train kmeans.
|
Max iterations to train kmeans.
|
||||||
|
|
||||||
@@ -373,7 +356,7 @@ class HnswSq:
|
|||||||
In those cases it is unlikely that setting this larger will lead to
|
In those cases it is unlikely that setting this larger will lead to
|
||||||
the index converging anyways.
|
the index converging anyways.
|
||||||
|
|
||||||
sample_rate: int, default 256
|
sample_rate, default 256
|
||||||
|
|
||||||
The rate used to calculate the number of training vectors for kmeans.
|
The rate used to calculate the number of training vectors for kmeans.
|
||||||
|
|
||||||
@@ -389,14 +372,14 @@ class HnswSq:
|
|||||||
Increasing this value might improve the quality of the index but in
|
Increasing this value might improve the quality of the index but in
|
||||||
most cases the default should be sufficient.
|
most cases the default should be sufficient.
|
||||||
|
|
||||||
m: int, default 20
|
m, default 20
|
||||||
|
|
||||||
The number of neighbors to select for each vector in the HNSW graph.
|
The number of neighbors to select for each vector in the HNSW graph.
|
||||||
|
|
||||||
This value controls the tradeoff between search speed and accuracy.
|
This value controls the tradeoff between search speed and accuracy.
|
||||||
The higher the value the more accurate the search but the slower it will be.
|
The higher the value the more accurate the search but the slower it will be.
|
||||||
|
|
||||||
ef_construction: int, default 300
|
ef_construction, default 300
|
||||||
|
|
||||||
The number of candidates to evaluate during the construction of the HNSW graph.
|
The number of candidates to evaluate during the construction of the HNSW graph.
|
||||||
|
|
||||||
@@ -407,7 +390,7 @@ class HnswSq:
|
|||||||
This value should be set to a value that is not less than `ef` in the search
|
This value should be set to a value that is not less than `ef` in the search
|
||||||
phase.
|
phase.
|
||||||
|
|
||||||
target_partition_size: int, default is 1,048,576
|
target_partition_size, default is 1,048,576
|
||||||
|
|
||||||
The target size of each partition.
|
The target size of each partition.
|
||||||
|
|
||||||
@@ -460,7 +443,7 @@ class HnswFlat:
|
|||||||
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
distance has a range of (-∞, ∞). If the vectors are normalized (i.e. their
|
||||||
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
l2 norm is 1), then dot distance is equivalent to the cosine distance.
|
||||||
|
|
||||||
num_partitions: int, default sqrt(num_rows)
|
num_partitions, default sqrt(num_rows)
|
||||||
|
|
||||||
The number of IVF partitions to create.
|
The number of IVF partitions to create.
|
||||||
|
|
||||||
@@ -470,18 +453,18 @@ class HnswFlat:
|
|||||||
graph, so setting this value higher reduces the peak memory use of
|
graph, so setting this value higher reduces the peak memory use of
|
||||||
training.
|
training.
|
||||||
|
|
||||||
max_iterations: int, default 50
|
max_iterations, default 50
|
||||||
|
|
||||||
Max iterations to train kmeans.
|
Max iterations to train kmeans.
|
||||||
|
|
||||||
When training an IVF index we use kmeans to calculate the partitions.
|
When training an IVF index we use kmeans to calculate the partitions.
|
||||||
This parameter controls how many iterations of kmeans to run.
|
This parameter controls how many iterations of kmeans to run.
|
||||||
|
|
||||||
sample_rate: int, default 256
|
sample_rate, default 256
|
||||||
|
|
||||||
The rate used to calculate the number of training vectors for kmeans.
|
The rate used to calculate the number of training vectors for kmeans.
|
||||||
|
|
||||||
m: int, default 20
|
m, default 20
|
||||||
|
|
||||||
The number of neighbors to select for each vector in the HNSW graph.
|
The number of neighbors to select for each vector in the HNSW graph.
|
||||||
|
|
||||||
@@ -489,7 +472,7 @@ class HnswFlat:
|
|||||||
The higher the value the more accurate the search but the slower it
|
The higher the value the more accurate the search but the slower it
|
||||||
will be.
|
will be.
|
||||||
|
|
||||||
ef_construction: int, default 300
|
ef_construction, default 300
|
||||||
|
|
||||||
The number of candidates to evaluate during the construction of the HNSW
|
The number of candidates to evaluate during the construction of the HNSW
|
||||||
graph.
|
graph.
|
||||||
@@ -501,7 +484,7 @@ class HnswFlat:
|
|||||||
than 500. This value should be set to a value that is not less than `ef`
|
than 500. This value should be set to a value that is not less than `ef`
|
||||||
in the search phase.
|
in the search phase.
|
||||||
|
|
||||||
target_partition_size: int, default is 1,048,576
|
target_partition_size, default is 1,048,576
|
||||||
|
|
||||||
The target size of each partition.
|
The target size of each partition.
|
||||||
"""
|
"""
|
||||||
@@ -605,7 +588,7 @@ class IvfFlat:
|
|||||||
|
|
||||||
The default value is 256.
|
The default value is 256.
|
||||||
|
|
||||||
target_partition_size: int, default is 8192
|
target_partition_size, default is 8192
|
||||||
|
|
||||||
The target size of each partition.
|
The target size of each partition.
|
||||||
|
|
||||||
@@ -769,7 +752,7 @@ class IvfPq:
|
|||||||
|
|
||||||
The default value is 256.
|
The default value is 256.
|
||||||
|
|
||||||
target_partition_size: int, default is 8192
|
target_partition_size, default is 8192
|
||||||
|
|
||||||
The target size of each partition.
|
The target size of each partition.
|
||||||
|
|
||||||
@@ -830,7 +813,7 @@ class IvfRq:
|
|||||||
sample_rate: int, default 256
|
sample_rate: int, default 256
|
||||||
Controls the number of training vectors: sample_rate * num_partitions.
|
Controls the number of training vectors: sample_rate * num_partitions.
|
||||||
|
|
||||||
target_partition_size: int, default is 8192
|
target_partition_size, default is 8192
|
||||||
Target size of each partition.
|
Target size of each partition.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -845,9 +828,6 @@ class IvfRq:
|
|||||||
accelerator: Optional[str] = None
|
accelerator: Optional[str] = None
|
||||||
|
|
||||||
|
|
||||||
# The API reference renders this module with a single mkdocstrings directive,
|
|
||||||
# which only picks up names listed here. New public names must be added to this
|
|
||||||
# list, or they will silently go undocumented.
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"BTree",
|
"BTree",
|
||||||
"IvfPq",
|
"IvfPq",
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ class LanceMergeInsertBuilder(object):
|
|||||||
self._when_not_matched_by_source_condition_expr = None
|
self._when_not_matched_by_source_condition_expr = None
|
||||||
self._timeout = None
|
self._timeout = None
|
||||||
self._use_index = True
|
self._use_index = True
|
||||||
self._use_lsm = None
|
self._use_lsm_write = None
|
||||||
self._validate_single_shard = None
|
self._validate_single_shard = None
|
||||||
|
|
||||||
def when_matched_update_all(
|
def when_matched_update_all(
|
||||||
@@ -113,22 +113,22 @@ class LanceMergeInsertBuilder(object):
|
|||||||
self._use_index = use_index
|
self._use_index = use_index
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def use_lsm(self, enable: bool) -> LanceMergeInsertBuilder:
|
def use_lsm_write(self, use_lsm_write: bool) -> LanceMergeInsertBuilder:
|
||||||
"""
|
"""
|
||||||
Control MemWAL routing for this merge.
|
Controls whether the merge uses the MemWAL LSM write path.
|
||||||
|
|
||||||
By default (unset), a `merge_insert` on a table with an LSM write spec is
|
By default (unset), a `merge_insert` on a table with an LSM write spec
|
||||||
routed through Lance's MemWAL shard writer, and a table without one uses
|
is routed through Lance's MemWAL shard writer, and a table without one
|
||||||
the standard path.
|
uses the standard path. Pass `False` to force the standard path even
|
||||||
|
when a spec is set. Pass `True` to require a spec — `merge_insert`
|
||||||
|
raises an error if none is installed.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
enable: bool
|
use_lsm_write: bool
|
||||||
``True`` forces MemWAL routing and errors if the table has no LSM
|
Whether to use the LSM write path.
|
||||||
write spec. ``False`` forces the standard write path even when a spec
|
|
||||||
is set.
|
|
||||||
"""
|
"""
|
||||||
self._use_lsm = enable
|
self._use_lsm_write = use_lsm_write
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def validate_single_shard(
|
def validate_single_shard(
|
||||||
|
|||||||
@@ -438,8 +438,7 @@ class Permutation:
|
|||||||
_reader: Optional[PermutationReader] = None,
|
_reader: Optional[PermutationReader] = None,
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Internal constructor. Use
|
Internal constructor. Use [from_tables](#from_tables) instead.
|
||||||
[from_tables][lancedb.permutation.Permutation.from_tables] instead.
|
|
||||||
"""
|
"""
|
||||||
assert base_table is not None, "base_table is required"
|
assert base_table is not None, "base_table is required"
|
||||||
assert selection is not None, "selection is required"
|
assert selection is not None, "selection is required"
|
||||||
@@ -886,7 +885,7 @@ class Permutation:
|
|||||||
This method refines the current selection, potentially removing columns. It
|
This method refines the current selection, potentially removing columns. It
|
||||||
will not add back columns that were previously removed.
|
will not add back columns that were previously removed.
|
||||||
|
|
||||||
If any of the columns do not exist then an error will be raised.
|
If any of the columns do not exist then an error will be raised
|
||||||
|
|
||||||
This does not introduce a post-processing step. It simply reduces the amount
|
This does not introduce a post-processing step. It simply reduces the amount
|
||||||
of data we read.
|
of data we read.
|
||||||
@@ -899,14 +898,9 @@ class Permutation:
|
|||||||
for name in columns:
|
for name in columns:
|
||||||
value = self.selection.get(name, None)
|
value = self.selection.get(name, None)
|
||||||
if value is None:
|
if value is None:
|
||||||
if name == "_rowid":
|
raise ValueError(
|
||||||
# _rowid is a system column not in the default schema
|
f"Cannot select column `{name}` because it does not exist"
|
||||||
# but can be explicitly selected
|
)
|
||||||
value = "_rowid"
|
|
||||||
else:
|
|
||||||
raise ValueError(
|
|
||||||
f"Cannot select column `{name}` because it does not exist"
|
|
||||||
)
|
|
||||||
new_selection[name] = value
|
new_selection[name] = value
|
||||||
return self._with_selection(new_selection)
|
return self._with_selection(new_selection)
|
||||||
|
|
||||||
@@ -986,9 +980,8 @@ class Permutation:
|
|||||||
types. Conversion of strings, lists, and structs will require creating python
|
types. Conversion of strings, lists, and structs will require creating python
|
||||||
objects and this is not zero-copy.
|
objects and this is not zero-copy.
|
||||||
|
|
||||||
For custom formatting, use
|
For custom formatting, use [with_transform](#with_transform) which overrides
|
||||||
[with_transform][lancedb.permutation.Permutation.with_transform] which
|
this method.
|
||||||
overrides this method.
|
|
||||||
"""
|
"""
|
||||||
assert format is not None, "format is required"
|
assert format is not None, "format is required"
|
||||||
if format == "python":
|
if format == "python":
|
||||||
@@ -1063,8 +1056,7 @@ class Permutation:
|
|||||||
Note: this method returns a new permutation and does not modify `self`
|
Note: this method returns a new permutation and does not modify `self`
|
||||||
It is provided for compatibility with the huggingface Dataset API.
|
It is provided for compatibility with the huggingface Dataset API.
|
||||||
|
|
||||||
Use [with_skip][lancedb.permutation.Permutation.with_skip] instead to
|
Use [with_skip](#with_skip) instead to avoid confusion.
|
||||||
avoid confusion.
|
|
||||||
"""
|
"""
|
||||||
return self.with_skip(skip)
|
return self.with_skip(skip)
|
||||||
|
|
||||||
@@ -1087,8 +1079,7 @@ class Permutation:
|
|||||||
Note: this method returns a new permutation and does not modify `self`
|
Note: this method returns a new permutation and does not modify `self`
|
||||||
It is provided for compatibility with the huggingface Dataset API.
|
It is provided for compatibility with the huggingface Dataset API.
|
||||||
|
|
||||||
Use [with_take][lancedb.permutation.Permutation.with_take] instead to
|
Use [with_take](#with_take) instead to avoid confusion.
|
||||||
avoid confusion.
|
|
||||||
"""
|
"""
|
||||||
return self.with_take(limit)
|
return self.with_take(limit)
|
||||||
|
|
||||||
@@ -1111,8 +1102,7 @@ class Permutation:
|
|||||||
Note: this method returns a new permutation and does not modify `self`
|
Note: this method returns a new permutation and does not modify `self`
|
||||||
It is provided for compatibility with the huggingface Dataset API.
|
It is provided for compatibility with the huggingface Dataset API.
|
||||||
|
|
||||||
Use [with_repeat][lancedb.permutation.Permutation.with_repeat] instead
|
Use [with_repeat](#with_repeat) instead to avoid confusion.
|
||||||
to avoid confusion.
|
|
||||||
"""
|
"""
|
||||||
return self.with_repeat(times)
|
return self.with_repeat(times)
|
||||||
|
|
||||||
|
|||||||
@@ -651,8 +651,7 @@ class Query(pydantic.BaseModel):
|
|||||||
distance_type : Optional[str]
|
distance_type : Optional[str]
|
||||||
the distance type to use for vector search
|
the distance type to use for vector search
|
||||||
|
|
||||||
This can be l2 (default), cosine and dot. See
|
This can be l2 (default), cosine and dot. See [metric definitions][search] for
|
||||||
[metric definitions](https://lancedb.com/docs/search/vector-search/) for
|
|
||||||
more details.
|
more details.
|
||||||
|
|
||||||
If this is not a vector search this will be None.
|
If this is not a vector search this will be None.
|
||||||
@@ -665,9 +664,8 @@ class Query(pydantic.BaseModel):
|
|||||||
|
|
||||||
- A higher number makes search more accurate but also slower.
|
- A higher number makes search more accurate but also slower.
|
||||||
|
|
||||||
- See discussion in
|
- See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
||||||
[Querying an ANN Index](https://lancedb.com/docs/indexing/)
|
tuning advice.
|
||||||
for tuning advice.
|
|
||||||
|
|
||||||
Will be None if this is not a vector search.
|
Will be None if this is not a vector search.
|
||||||
refine_factor : Optional[int]
|
refine_factor : Optional[int]
|
||||||
@@ -675,9 +673,8 @@ class Query(pydantic.BaseModel):
|
|||||||
|
|
||||||
- A higher number makes search more accurate but also slower.
|
- A higher number makes search more accurate but also slower.
|
||||||
|
|
||||||
- See discussion in
|
- See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
||||||
[Querying an ANN Index](https://lancedb.com/docs/indexing/)
|
tuning advice.
|
||||||
for tuning advice.
|
|
||||||
|
|
||||||
Will be None if this is not a vector search.
|
Will be None if this is not a vector search.
|
||||||
lower_bound : Optional[float]
|
lower_bound : Optional[float]
|
||||||
@@ -781,11 +778,6 @@ class Query(pydantic.BaseModel):
|
|||||||
# if true, will only search the indexed data
|
# if true, will only search the indexed data
|
||||||
fast_search: Optional[bool] = None
|
fast_search: Optional[bool] = None
|
||||||
|
|
||||||
# MemWAL LSM read routing: None auto-routes when the table carries a write
|
|
||||||
# spec, True forces the LSM scanner (errors without a spec), False reads the
|
|
||||||
# base table only
|
|
||||||
use_lsm: Optional[bool] = None
|
|
||||||
|
|
||||||
# size of the nearest neighbor list maintained during HNSW search
|
# size of the nearest neighbor list maintained during HNSW search
|
||||||
ef: Optional[int] = None
|
ef: Optional[int] = None
|
||||||
|
|
||||||
@@ -803,9 +795,6 @@ class Query(pydantic.BaseModel):
|
|||||||
query.full_text_query = req.full_text_search
|
query.full_text_query = req.full_text_search
|
||||||
query.columns = req.select
|
query.columns = req.select
|
||||||
query.with_row_id = req.with_row_id
|
query.with_row_id = req.with_row_id
|
||||||
# use_lsm is a genuine tri-state (None / True / False); preserve it as-is
|
|
||||||
# so a round-tripped query keeps an explicit False.
|
|
||||||
query.use_lsm = req.use_lsm
|
|
||||||
query.vector_column = req.column
|
query.vector_column = req.column
|
||||||
query.vector = req.query_vector
|
query.vector = req.query_vector
|
||||||
query.distance_type = req.distance_type
|
query.distance_type = req.distance_type
|
||||||
@@ -978,7 +967,6 @@ class LanceQueryBuilder(ABC):
|
|||||||
self._with_row_address = None
|
self._with_row_address = None
|
||||||
self._fragments = None
|
self._fragments = None
|
||||||
self._fragment_ids = None
|
self._fragment_ids = None
|
||||||
self._use_lsm = None
|
|
||||||
self._vector = None
|
self._vector = None
|
||||||
self._text = None
|
self._text = None
|
||||||
self._ef = None
|
self._ef = None
|
||||||
@@ -1338,30 +1326,6 @@ class LanceQueryBuilder(ABC):
|
|||||||
self._fragment_ids = fragment_ids
|
self._fragment_ids = fragment_ids
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def use_lsm(self, enable: bool) -> Self:
|
|
||||||
"""Control MemWAL LSM read routing for this query.
|
|
||||||
|
|
||||||
By default (unset), a query against a table with an LSM write spec is
|
|
||||||
routed through the LSM scanner so it also returns data written via the
|
|
||||||
``merge_insert`` LSM path that has not yet been compacted into the base
|
|
||||||
table (active/frozen memtables + flushed generations); a table without a
|
|
||||||
spec reads the base table.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
enable : bool
|
|
||||||
``True`` forces the LSM scanner and errors if the table has no LSM
|
|
||||||
write spec. ``False`` bypasses the MemWAL and reads the base table
|
|
||||||
only, even when a spec is present.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
LanceQueryBuilder
|
|
||||||
The LanceQueryBuilder object.
|
|
||||||
"""
|
|
||||||
self._use_lsm = enable
|
|
||||||
return self
|
|
||||||
|
|
||||||
def explain_plan(self, verbose: Optional[bool] = False) -> str:
|
def explain_plan(self, verbose: Optional[bool] = False) -> str:
|
||||||
"""Return the execution plan for this query.
|
"""Return the execution plan for this query.
|
||||||
|
|
||||||
@@ -1654,8 +1618,8 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
Higher values will yield better recall (more likely to find vectors if
|
Higher values will yield better recall (more likely to find vectors if
|
||||||
they exist) at the expense of latency.
|
they exist) at the expense of latency.
|
||||||
|
|
||||||
See discussion in [Querying an ANN Index](https://lancedb.com/docs/indexing/)
|
See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
||||||
for tuning advice.
|
tuning advice.
|
||||||
|
|
||||||
This method sets both the minimum and maximum number of probes to the same
|
This method sets both the minimum and maximum number of probes to the same
|
||||||
value. See `minimum_nprobes` and `maximum_nprobes` for more fine-grained
|
value. See `minimum_nprobes` and `maximum_nprobes` for more fine-grained
|
||||||
@@ -1755,8 +1719,8 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
As an example, a refine factor of 2 will sample 2x as many vectors as
|
As an example, a refine factor of 2 will sample 2x as many vectors as
|
||||||
requested, re-ranks them, and returns the top half most relevant results.
|
requested, re-ranks them, and returns the top half most relevant results.
|
||||||
|
|
||||||
See discussion in [Querying an ANN Index](https://lancedb.com/docs/indexing/)
|
See discussion in [Querying an ANN Index][querying-an-ann-index] for
|
||||||
for tuning advice.
|
tuning advice.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -1824,7 +1788,6 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
|
|||||||
with_row_address=self._with_row_address,
|
with_row_address=self._with_row_address,
|
||||||
fragments=self._fragments,
|
fragments=self._fragments,
|
||||||
fragment_ids=self._fragment_ids,
|
fragment_ids=self._fragment_ids,
|
||||||
use_lsm=self._use_lsm,
|
|
||||||
offset=self._offset,
|
offset=self._offset,
|
||||||
fast_search=self._fast_search,
|
fast_search=self._fast_search,
|
||||||
ef=self._ef,
|
ef=self._ef,
|
||||||
@@ -2049,7 +2012,6 @@ class LanceFtsQueryBuilder(LanceQueryBuilder):
|
|||||||
with_row_address=self._with_row_address,
|
with_row_address=self._with_row_address,
|
||||||
fragments=self._fragments,
|
fragments=self._fragments,
|
||||||
fragment_ids=self._fragment_ids,
|
fragment_ids=self._fragment_ids,
|
||||||
use_lsm=self._use_lsm,
|
|
||||||
full_text_query=FullTextSearchQuery(
|
full_text_query=FullTextSearchQuery(
|
||||||
query=self._query_with_phrase_semantics(), columns=self._fts_columns
|
query=self._query_with_phrase_semantics(), columns=self._fts_columns
|
||||||
),
|
),
|
||||||
@@ -2116,7 +2078,6 @@ class LanceEmptyQueryBuilder(LanceQueryBuilder):
|
|||||||
with_row_address=self._with_row_address,
|
with_row_address=self._with_row_address,
|
||||||
fragments=self._fragments,
|
fragments=self._fragments,
|
||||||
fragment_ids=self._fragment_ids,
|
fragment_ids=self._fragment_ids,
|
||||||
use_lsm=self._use_lsm,
|
|
||||||
offset=self._offset,
|
offset=self._offset,
|
||||||
order_by=self._order_by,
|
order_by=self._order_by,
|
||||||
)
|
)
|
||||||
@@ -2694,9 +2655,6 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
|
|||||||
if self._with_row_id:
|
if self._with_row_id:
|
||||||
self._vector_query.with_row_id(True)
|
self._vector_query.with_row_id(True)
|
||||||
self._fts_query.with_row_id(True)
|
self._fts_query.with_row_id(True)
|
||||||
if self._use_lsm is not None:
|
|
||||||
self._vector_query.use_lsm(self._use_lsm)
|
|
||||||
self._fts_query.use_lsm(self._use_lsm)
|
|
||||||
if self._phrase_query:
|
if self._phrase_query:
|
||||||
self._fts_query.phrase_query(True)
|
self._fts_query.phrase_query(True)
|
||||||
if self._distance_type:
|
if self._distance_type:
|
||||||
@@ -3044,7 +3002,7 @@ class AsyncQueryBase(object):
|
|||||||
if blob_mode == "bytes"
|
if blob_mode == "bytes"
|
||||||
else {}
|
else {}
|
||||||
)
|
)
|
||||||
dataset = await self._table.to_lance()
|
dataset = await self._table._to_lance()
|
||||||
scanner = dataset.scanner(
|
scanner = dataset.scanner(
|
||||||
**_scanner_kwargs_for_query(
|
**_scanner_kwargs_for_query(
|
||||||
query,
|
query,
|
||||||
@@ -3273,27 +3231,6 @@ class AsyncStandardQuery(AsyncQueryBase):
|
|||||||
self._inner.fast_search()
|
self._inner.fast_search()
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def use_lsm(self, enable: bool) -> Self:
|
|
||||||
"""
|
|
||||||
Control MemWAL LSM read routing for this query.
|
|
||||||
|
|
||||||
By default (unset), a query against a table with an LSM write spec (see
|
|
||||||
[AsyncTable.set_lsm_write_spec][lancedb.table.AsyncTable.set_lsm_write_spec])
|
|
||||||
is routed through the LSM scanner so it also returns data written via the
|
|
||||||
``merge_insert`` LSM path that has not yet been compacted into the base
|
|
||||||
table (the active/frozen in-memory memtables and the flushed generations),
|
|
||||||
deduplicated by primary key; a table without a spec reads the base table.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
enable : bool
|
|
||||||
``True`` forces the LSM scanner and errors if the table has no LSM
|
|
||||||
write spec. ``False`` bypasses the MemWAL and reads the base table
|
|
||||||
only, even when a spec is present.
|
|
||||||
"""
|
|
||||||
self._inner.use_lsm(enable)
|
|
||||||
return self
|
|
||||||
|
|
||||||
def postfilter(self) -> Self:
|
def postfilter(self) -> Self:
|
||||||
"""
|
"""
|
||||||
If this is called then filtering will happen after the search instead of
|
If this is called then filtering will happen after the search instead of
|
||||||
@@ -3382,9 +3319,8 @@ class AsyncQuery(AsyncStandardQuery):
|
|||||||
are various ANN search parameters that will let you fine tune your recall
|
are various ANN search parameters that will let you fine tune your recall
|
||||||
accuracy vs search latency.
|
accuracy vs search latency.
|
||||||
|
|
||||||
Vector searches always have a
|
Vector searches always have a [limit][]. If `limit` has not been called then
|
||||||
[limit][lancedb.query.AsyncVectorQuery.limit]. If `limit` has not been
|
a default `limit` of 10 will be used.
|
||||||
called then a default `limit` of 10 will be used.
|
|
||||||
|
|
||||||
Typically, a single vector is passed in as the query. However, you can also
|
Typically, a single vector is passed in as the query. However, you can also
|
||||||
pass in multiple vectors. When multiple vectors are passed in, if the vector
|
pass in multiple vectors. When multiple vectors are passed in, if the vector
|
||||||
@@ -3515,9 +3451,8 @@ class AsyncFTSQuery(AsyncStandardQuery):
|
|||||||
are various ANN search parameters that will let you fine tune your recall
|
are various ANN search parameters that will let you fine tune your recall
|
||||||
accuracy vs search latency.
|
accuracy vs search latency.
|
||||||
|
|
||||||
Hybrid searches always have a
|
Hybrid searches always have a [limit][]. If `limit` has not been called then
|
||||||
[limit][lancedb.query.AsyncHybridQuery.limit]. If `limit` has not been
|
a default `limit` of 10 will be used.
|
||||||
called then a default `limit` of 10 will be used.
|
|
||||||
|
|
||||||
Typically, a single vector is passed in as the query. However, you can also
|
Typically, a single vector is passed in as the query. However, you can also
|
||||||
pass in multiple vectors. This can be useful if you want to find the nearest
|
pass in multiple vectors. This can be useful if you want to find the nearest
|
||||||
@@ -4009,15 +3944,6 @@ class AsyncTakeQuery(AsyncQueryBase):
|
|||||||
def __init__(self, inner: LanceTakeQuery, table: Optional["AsyncTable"] = None):
|
def __init__(self, inner: LanceTakeQuery, table: Optional["AsyncTable"] = None):
|
||||||
super().__init__(inner, table)
|
super().__init__(inner, table)
|
||||||
|
|
||||||
def use_lsm(self, enable: bool) -> "AsyncTakeQuery":
|
|
||||||
"""Control MemWAL LSM read routing for this take query.
|
|
||||||
|
|
||||||
``False`` bypasses the MemWAL and reads the base table only — the escape
|
|
||||||
hatch, since take-by-row-id/offset is not supported on the LSM scanner.
|
|
||||||
"""
|
|
||||||
self._inner.use_lsm(enable)
|
|
||||||
return self
|
|
||||||
|
|
||||||
async def _plain_scan_to_pandas(
|
async def _plain_scan_to_pandas(
|
||||||
self,
|
self,
|
||||||
blob_mode: BlobMode,
|
blob_mode: BlobMode,
|
||||||
@@ -4076,16 +4002,6 @@ class BaseQueryBuilder(object):
|
|||||||
self._inner.with_row_id()
|
self._inner.with_row_id()
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def use_lsm(self, enable: bool) -> Self:
|
|
||||||
"""
|
|
||||||
Control MemWAL LSM read routing for this query.
|
|
||||||
|
|
||||||
``False`` bypasses the MemWAL and reads the base table only, the escape
|
|
||||||
hatch for shapes the LSM scanner cannot honor (e.g. take-by-row-id).
|
|
||||||
"""
|
|
||||||
self._inner.use_lsm(enable)
|
|
||||||
return self
|
|
||||||
|
|
||||||
def with_row_address(self, with_row_address: bool = True) -> Self:
|
def with_row_address(self, with_row_address: bool = True) -> Self:
|
||||||
"""
|
"""
|
||||||
Include the _rowaddr column in scanner-backed plain query results.
|
Include the _rowaddr column in scanner-backed plain query results.
|
||||||
|
|||||||
@@ -11,9 +11,6 @@ from lancedb import __version__
|
|||||||
from .header import HeaderProvider
|
from .header import HeaderProvider
|
||||||
from .oauth import OAuthConfig, OAuthFlowType
|
from .oauth import OAuthConfig, OAuthFlowType
|
||||||
|
|
||||||
# The API reference renders this module with a single mkdocstrings directive,
|
|
||||||
# which only picks up names listed here. New public names must be added to this
|
|
||||||
# list, or they will silently go undocumented.
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"TimeoutConfig",
|
"TimeoutConfig",
|
||||||
"RetryConfig",
|
"RetryConfig",
|
||||||
|
|||||||
@@ -53,9 +53,9 @@ class RetryError(LanceDBClientError):
|
|||||||
"""An error that occurs when the client has exceeded the maximum number of retries.
|
"""An error that occurs when the client has exceeded the maximum number of retries.
|
||||||
|
|
||||||
The retry strategy can be adjusted by setting the
|
The retry strategy can be adjusted by setting the
|
||||||
[retry_config][lancedb.remote.ClientConfig.retry_config] in the client
|
[retry_config](lancedb.remote.ClientConfig.retry_config) in the client
|
||||||
configuration. This is passed in the `client_config` argument of
|
configuration. This is passed in the `client_config` argument of
|
||||||
[connect][lancedb.connect] and [connect_async][lancedb.connect_async].
|
[connect](lancedb.connect) and [connect_async](lancedb.connect_async).
|
||||||
|
|
||||||
The __cause__ attribute of this exception will be the last exception that
|
The __cause__ attribute of this exception will be the last exception that
|
||||||
caused the retry to fail. It will be an
|
caused the retry to fail. It will be an
|
||||||
|
|||||||
@@ -340,12 +340,10 @@ class RemoteTable(Table):
|
|||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = True,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = True,
|
||||||
custom_stop_words: Optional[List[str]] = None,
|
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = True,
|
||||||
ngram_min_length: int = 3,
|
ngram_min_length: int = 3,
|
||||||
ngram_max_length: int = 3,
|
ngram_max_length: int = 3,
|
||||||
prefix_only: bool = False,
|
prefix_only: bool = False,
|
||||||
block_size: int = 128,
|
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
):
|
):
|
||||||
"""Create a full-text search index on a column.
|
"""Create a full-text search index on a column.
|
||||||
@@ -362,12 +360,10 @@ class RemoteTable(Table):
|
|||||||
lower_case=lower_case,
|
lower_case=lower_case,
|
||||||
stem=stem,
|
stem=stem,
|
||||||
remove_stop_words=remove_stop_words,
|
remove_stop_words=remove_stop_words,
|
||||||
custom_stop_words=custom_stop_words,
|
|
||||||
ascii_folding=ascii_folding,
|
ascii_folding=ascii_folding,
|
||||||
ngram_min_length=ngram_min_length,
|
ngram_min_length=ngram_min_length,
|
||||||
ngram_max_length=ngram_max_length,
|
ngram_max_length=ngram_max_length,
|
||||||
prefix_only=prefix_only,
|
prefix_only=prefix_only,
|
||||||
block_size=block_size,
|
|
||||||
)
|
)
|
||||||
LOOP.run(
|
LOOP.run(
|
||||||
self._table.create_index(
|
self._table.create_index(
|
||||||
@@ -580,9 +576,8 @@ class RemoteTable(Table):
|
|||||||
progress: Optional[Union[bool, Callable, Any]] = None,
|
progress: Optional[Union[bool, Callable, Any]] = None,
|
||||||
write_parallelism: Optional[int] = None,
|
write_parallelism: Optional[int] = None,
|
||||||
) -> AddResult:
|
) -> AddResult:
|
||||||
"""Add more data to the [Table][lancedb.table.Table].
|
"""Add more data to the [Table](Table). It has the same API signature as
|
||||||
|
the OSS version.
|
||||||
It has the same API signature as the OSS version.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -642,8 +637,7 @@ class RemoteTable(Table):
|
|||||||
fast_search: bool = False,
|
fast_search: bool = False,
|
||||||
) -> LanceVectorQueryBuilder:
|
) -> LanceVectorQueryBuilder:
|
||||||
"""Create a search query to find the nearest neighbors
|
"""Create a search query to find the nearest neighbors
|
||||||
of the given query vector. We currently support
|
of the given query vector. We currently support [vector search][search]
|
||||||
[vector search](https://lancedb.com/docs/search/vector-search/)
|
|
||||||
|
|
||||||
All query options are defined in
|
All query options are defined in
|
||||||
[LanceVectorQueryBuilder][lancedb.query.LanceVectorQueryBuilder].
|
[LanceVectorQueryBuilder][lancedb.query.LanceVectorQueryBuilder].
|
||||||
@@ -1046,11 +1040,6 @@ class RemoteTable(Table):
|
|||||||
def fetch_blobs(self, column: str, row_ids) -> pa.LargeBinaryArray:
|
def fetch_blobs(self, column: str, row_ids) -> pa.LargeBinaryArray:
|
||||||
raise NotImplementedError("fetch_blobs() is not supported on LanceDB Cloud")
|
raise NotImplementedError("fetch_blobs() is not supported on LanceDB Cloud")
|
||||||
|
|
||||||
def fetch_blob_ranges(self, column: str, requests) -> pa.LargeBinaryArray:
|
|
||||||
raise NotImplementedError(
|
|
||||||
"fetch_blob_ranges() is not supported on LanceDB Cloud"
|
|
||||||
)
|
|
||||||
|
|
||||||
def fetch_blob_files(self, column: str, row_ids):
|
def fetch_blob_files(self, column: str, row_ids):
|
||||||
raise NotImplementedError(
|
raise NotImplementedError(
|
||||||
"fetch_blob_files() is not supported on LanceDB Cloud"
|
"fetch_blob_files() is not supported on LanceDB Cloud"
|
||||||
|
|||||||
@@ -14,9 +14,6 @@ from .answerdotai import AnswerdotaiRerankers
|
|||||||
from .voyageai import VoyageAIReranker
|
from .voyageai import VoyageAIReranker
|
||||||
from .watsonx import WatsonxReranker
|
from .watsonx import WatsonxReranker
|
||||||
|
|
||||||
# The API reference renders this module with a single mkdocstrings directive,
|
|
||||||
# which only picks up names listed here. New public names must be added to this
|
|
||||||
# list, or they will silently go undocumented.
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"Reranker",
|
"Reranker",
|
||||||
"CrossEncoderReranker",
|
"CrossEncoderReranker",
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ class AnswerdotaiRerankers(Reranker):
|
|||||||
column : str, default "text"
|
column : str, default "text"
|
||||||
The name of the column to use as input to the cross encoder model.
|
The name of the column to use as input to the cross encoder model.
|
||||||
return_score : str, default "relevance"
|
return_score : str, default "relevance"
|
||||||
options are "relevance" or "all".
|
options are "relevance" or "all". Only "relevance" is supported for now.
|
||||||
**kwargs
|
**kwargs
|
||||||
Additional keyword arguments to pass to the model. For example, 'device'.
|
Additional keyword arguments to pass to the model. For example, 'device'.
|
||||||
See AnswerDotAI/rerankers for more information.
|
See AnswerDotAI/rerankers for more information.
|
||||||
@@ -77,13 +77,12 @@ class AnswerdotaiRerankers(Reranker):
|
|||||||
vector_results: pa.Table,
|
vector_results: pa.Table,
|
||||||
fts_results: pa.Table,
|
fts_results: pa.Table,
|
||||||
):
|
):
|
||||||
if self.score == "all":
|
combined_results = self.merge_results(vector_results, fts_results)
|
||||||
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
|
||||||
else:
|
|
||||||
combined_results = self.merge_results(vector_results, fts_results)
|
|
||||||
combined_results = self._rerank(combined_results, query)
|
combined_results = self._rerank(combined_results, query)
|
||||||
if self.score == "relevance":
|
if self.score == "relevance":
|
||||||
combined_results = self._keep_relevance_score(combined_results)
|
combined_results = self._keep_relevance_score(combined_results)
|
||||||
|
elif self.score == "all":
|
||||||
|
combined_results = self._merge_and_keep_scores(vector_results, fts_results)
|
||||||
combined_results = combined_results.sort_by(
|
combined_results = combined_results.sort_by(
|
||||||
[("_relevance_score", "descending")]
|
[("_relevance_score", "descending")]
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ class ColbertReranker(AnswerdotaiRerankers):
|
|||||||
column : str, default "text"
|
column : str, default "text"
|
||||||
The name of the column to use as input to the cross encoder model.
|
The name of the column to use as input to the cross encoder model.
|
||||||
return_score : str, default "relevance"
|
return_score : str, default "relevance"
|
||||||
options are "relevance" or "all".
|
options are "relevance" or "all". Only "relevance" is supported for now.
|
||||||
**kwargs
|
**kwargs
|
||||||
Additional keyword arguments to pass to the model, for example, 'device'.
|
Additional keyword arguments to pass to the model, for example, 'device'.
|
||||||
See AnswerDotAI/rerankers for more information.
|
See AnswerDotAI/rerankers for more information.
|
||||||
|
|||||||
@@ -59,10 +59,9 @@ class StreamingDataset(IterableDataset):
|
|||||||
- **Stage 1 (I/O)**: one thread pool with ``num_splits * prefetch_batches``
|
- **Stage 1 (I/O)**: one thread pool with ``num_splits * prefetch_batches``
|
||||||
workers fetches raw ``RecordBatch`` objects from LanceDB in parallel
|
workers fetches raw ``RecordBatch`` objects from LanceDB in parallel
|
||||||
across all splits and places them in a per-split raw-batch queue.
|
across all splits and places them in a per-split raw-batch queue.
|
||||||
- **Stage 2 (transform)**: a second thread pool with
|
- **Stage 2 (transform)**: a second thread pool with ``os.cpu_count()``
|
||||||
``transform_parallelism`` workers picks up raw batches, applies the
|
workers picks up raw batches, applies the transform, and places the
|
||||||
transform, and places the results in a per-split cooked-row queue. By
|
results in a per-split cooked-row queue.
|
||||||
default, the number of workers is determined by ``os.cpu_count()``.
|
|
||||||
|
|
||||||
The main thread round-robins over the cooked queues, yielding one row per
|
The main thread round-robins over the cooked queues, yielding one row per
|
||||||
split per cycle.
|
split per cycle.
|
||||||
@@ -123,10 +122,6 @@ class StreamingDataset(IterableDataset):
|
|||||||
are yielded. Receives one batch at a time and must return an iterable
|
are yielded. Receives one batch at a time and must return an iterable
|
||||||
whose length equals the number of rows in the batch. When ``None``
|
whose length equals the number of rows in the batch. When ``None``
|
||||||
(the default) rows are returned as plain Python dicts.
|
(the default) rows are returned as plain Python dicts.
|
||||||
transform_parallelism:
|
|
||||||
Maximum number of transforms to run concurrently. Must be greater
|
|
||||||
than zero. When ``None`` (the default), uses ``os.cpu_count()`` or 1
|
|
||||||
when the CPU count is unavailable.
|
|
||||||
worker_info_override:
|
worker_info_override:
|
||||||
If set, used in place of ``torch.utils.data.get_worker_info()`` to
|
If set, used in place of ``torch.utils.data.get_worker_info()`` to
|
||||||
determine the DataLoader worker assignment. Intended for unit tests
|
determine the DataLoader worker assignment. Intended for unit tests
|
||||||
@@ -151,7 +146,6 @@ class StreamingDataset(IterableDataset):
|
|||||||
shuffle_clump_size: Optional[int] = None,
|
shuffle_clump_size: Optional[int] = None,
|
||||||
filter: Optional[str] = None,
|
filter: Optional[str] = None,
|
||||||
transform: Optional[Callable] = None,
|
transform: Optional[Callable] = None,
|
||||||
transform_parallelism: Optional[int] = None,
|
|
||||||
connection_factory: Optional[Callable[[str], Any]] = None,
|
connection_factory: Optional[Callable[[str], Any]] = None,
|
||||||
worker_info_override=None,
|
worker_info_override=None,
|
||||||
):
|
):
|
||||||
@@ -165,8 +159,6 @@ class StreamingDataset(IterableDataset):
|
|||||||
f"num_splits ({num_splits}) must be divisible by "
|
f"num_splits ({num_splits}) must be divisible by "
|
||||||
f"world_size ({world_size})"
|
f"world_size ({world_size})"
|
||||||
)
|
)
|
||||||
if transform_parallelism is not None and transform_parallelism <= 0:
|
|
||||||
raise ValueError("transform_parallelism must be greater than 0")
|
|
||||||
|
|
||||||
self._table = table
|
self._table = table
|
||||||
self._num_splits = num_splits
|
self._num_splits = num_splits
|
||||||
@@ -181,7 +173,6 @@ class StreamingDataset(IterableDataset):
|
|||||||
self._shuffle_clump_size = shuffle_clump_size
|
self._shuffle_clump_size = shuffle_clump_size
|
||||||
self._filter = filter
|
self._filter = filter
|
||||||
self._transform = transform
|
self._transform = transform
|
||||||
self._transform_parallelism = transform_parallelism
|
|
||||||
self._connection_factory = connection_factory
|
self._connection_factory = connection_factory
|
||||||
self._worker_info_override = worker_info_override
|
self._worker_info_override = worker_info_override
|
||||||
|
|
||||||
@@ -293,11 +284,7 @@ class StreamingDataset(IterableDataset):
|
|||||||
|
|
||||||
batch_size = self._read_batch_size
|
batch_size = self._read_batch_size
|
||||||
max_prefetch = self._prefetch_batches
|
max_prefetch = self._prefetch_batches
|
||||||
transform_workers = (
|
cpu_workers = os.cpu_count() or 1
|
||||||
self._transform_parallelism
|
|
||||||
if self._transform_parallelism is not None
|
|
||||||
else (os.cpu_count() or 1)
|
|
||||||
)
|
|
||||||
final_transform = (
|
final_transform = (
|
||||||
self._transform if self._transform is not None else Transforms.arrow2python
|
self._transform if self._transform is not None else Transforms.arrow2python
|
||||||
)
|
)
|
||||||
@@ -309,8 +296,8 @@ class StreamingDataset(IterableDataset):
|
|||||||
tx_pending = [deque() for _ in range(n)] # Future[list[Any]]
|
tx_pending = [deque() for _ in range(n)] # Future[list[Any]]
|
||||||
cooked = [deque() for _ in range(n)] # rows ready to yield
|
cooked = [deque() for _ in range(n)] # rows ready to yield
|
||||||
|
|
||||||
# Limit simultaneous transforms to transform_workers across all splits.
|
# Limit simultaneous transforms to cpu_workers across all splits.
|
||||||
tx_semaphore = threading.Semaphore(transform_workers)
|
tx_semaphore = threading.Semaphore(cpu_workers)
|
||||||
|
|
||||||
# ── Stage 1 helpers ───────────────────────────────────────────────────
|
# ── Stage 1 helpers ───────────────────────────────────────────────────
|
||||||
|
|
||||||
@@ -382,7 +369,7 @@ class StreamingDataset(IterableDataset):
|
|||||||
_advance(i)
|
_advance(i)
|
||||||
elif raw_batches[i]:
|
elif raw_batches[i]:
|
||||||
# Acquire a transform slot (may block briefly if all
|
# Acquire a transform slot (may block briefly if all
|
||||||
# transform_workers are busy with other splits).
|
# cpu_workers are busy with other splits).
|
||||||
tx_semaphore.acquire()
|
tx_semaphore.acquire()
|
||||||
batch = raw_batches[i].popleft()
|
batch = raw_batches[i].popleft()
|
||||||
tx_pending[i].append(tx_pool.submit(_tx_call_guarded, batch))
|
tx_pending[i].append(tx_pool.submit(_tx_call_guarded, batch))
|
||||||
@@ -396,7 +383,7 @@ class StreamingDataset(IterableDataset):
|
|||||||
# ── Main loop ─────────────────────────────────────────────────────────
|
# ── Main loop ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
with ThreadPoolExecutor(max_workers=n * max_prefetch) as io_pool:
|
with ThreadPoolExecutor(max_workers=n * max_prefetch) as io_pool:
|
||||||
with ThreadPoolExecutor(max_workers=transform_workers) as tx_pool:
|
with ThreadPoolExecutor(max_workers=cpu_workers) as tx_pool:
|
||||||
self._raw_batches_ref = raw_batches
|
self._raw_batches_ref = raw_batches
|
||||||
self._cooked_ref = cooked
|
self._cooked_ref = cooked
|
||||||
self._fetch_head_ref = fetch_head
|
self._fetch_head_ref = fetch_head
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ from typing import (
|
|||||||
List,
|
List,
|
||||||
Literal,
|
Literal,
|
||||||
Optional,
|
Optional,
|
||||||
Sequence,
|
|
||||||
Tuple,
|
Tuple,
|
||||||
Union,
|
Union,
|
||||||
overload,
|
overload,
|
||||||
@@ -1103,12 +1102,10 @@ class Table(ABC):
|
|||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = True,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = True,
|
||||||
custom_stop_words: Optional[List[str]] = None,
|
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = True,
|
||||||
ngram_min_length: int = 3,
|
ngram_min_length: int = 3,
|
||||||
ngram_max_length: int = 3,
|
ngram_max_length: int = 3,
|
||||||
prefix_only: bool = False,
|
prefix_only: bool = False,
|
||||||
block_size: int = 128,
|
|
||||||
wait_timeout: Optional[timedelta] = None,
|
wait_timeout: Optional[timedelta] = None,
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
):
|
):
|
||||||
@@ -1171,9 +1168,6 @@ class Table(ABC):
|
|||||||
remove_stop_words : bool, default True
|
remove_stop_words : bool, default True
|
||||||
Whether to remove stop words. Stop words are common words that are often
|
Whether to remove stop words. Stop words are common words that are often
|
||||||
removed from text before indexing. For example, in English "the" and "and".
|
removed from text before indexing. For example, in English "the" and "and".
|
||||||
custom_stop_words : list of str, optional
|
|
||||||
Custom words that replace the built-in language stop words. ``None``
|
|
||||||
uses the built-in list; an empty list explicitly uses no stop words.
|
|
||||||
ascii_folding : bool, default True
|
ascii_folding : bool, default True
|
||||||
Whether to fold ASCII characters. This converts accented characters to
|
Whether to fold ASCII characters. This converts accented characters to
|
||||||
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
their ASCII equivalent. For example, "café" would be converted to "cafe".
|
||||||
@@ -1183,10 +1177,6 @@ class Table(ABC):
|
|||||||
The maximum length of an n-gram.
|
The maximum length of an n-gram.
|
||||||
prefix_only: bool, default False
|
prefix_only: bool, default False
|
||||||
Whether to only index the prefix of the token for ngram tokenizer.
|
Whether to only index the prefix of the token for ngram tokenizer.
|
||||||
block_size: int, default 128
|
|
||||||
The number of documents per compressed posting block. Must be 128
|
|
||||||
or 256. A value of 256 uses the experimental FTS V3 format and
|
|
||||||
may introduce breaking changes.
|
|
||||||
wait_timeout: timedelta, optional
|
wait_timeout: timedelta, optional
|
||||||
The timeout to wait if indexing is asynchronous.
|
The timeout to wait if indexing is asynchronous.
|
||||||
name: str, optional
|
name: str, optional
|
||||||
@@ -1211,7 +1201,7 @@ class Table(ABC):
|
|||||||
progress: Optional[Union[bool, Callable, Any]] = None,
|
progress: Optional[Union[bool, Callable, Any]] = None,
|
||||||
write_parallelism: Optional[int] = None,
|
write_parallelism: Optional[int] = None,
|
||||||
) -> AddResult:
|
) -> AddResult:
|
||||||
"""Add more data to the [Table][lancedb.table.Table].
|
"""Add more data to the [Table](Table).
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -1343,8 +1333,8 @@ class Table(ABC):
|
|||||||
fts_columns: Optional[Union[str, List[str]]] = None,
|
fts_columns: Optional[Union[str, List[str]]] = None,
|
||||||
) -> LanceQueryBuilder:
|
) -> LanceQueryBuilder:
|
||||||
"""Create a search query to find the nearest neighbors
|
"""Create a search query to find the nearest neighbors
|
||||||
of the given query vector. We currently support [vector search](https://lancedb.com/docs/search/vector-search/)
|
of the given query vector. We currently support [vector search][search]
|
||||||
and [full-text search](https://lancedb.com/docs/search/full-text-search/).
|
and [full-text search][experimental-full-text-search].
|
||||||
|
|
||||||
All query options are defined in
|
All query options are defined in
|
||||||
[LanceQueryBuilder][lancedb.query.LanceQueryBuilder].
|
[LanceQueryBuilder][lancedb.query.LanceQueryBuilder].
|
||||||
@@ -1543,30 +1533,10 @@ class Table(ABC):
|
|||||||
) -> pa.LargeBinaryArray:
|
) -> pa.LargeBinaryArray:
|
||||||
"""Materialize full blob bytes for ``column`` at the given rows.
|
"""Materialize full blob bytes for ``column`` at the given rows.
|
||||||
|
|
||||||
The result has the same length and order as ``row_ids``. Null blobs
|
|
||||||
produce null slots; valid empty blobs produce ``b""``.
|
|
||||||
|
|
||||||
Convenience for small payloads. For large values use
|
Convenience for small payloads. For large values use
|
||||||
:meth:`fetch_blob_files`.
|
:meth:`fetch_blob_files`.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def fetch_blob_ranges(
|
|
||||||
self,
|
|
||||||
column: str,
|
|
||||||
requests: Sequence[Tuple[int, int, int]],
|
|
||||||
) -> pa.LargeBinaryArray:
|
|
||||||
"""Materialize row-specific byte ranges from a blob v2 column.
|
|
||||||
|
|
||||||
Each request is a ``(row_id, offset, length)`` tuple. Requests may be
|
|
||||||
repeated or reordered, including multiple ranges for the same blob.
|
|
||||||
The result has the same length and order as ``requests``; null blobs
|
|
||||||
produce null slots and empty ranges on non-null blobs produce ``b""``.
|
|
||||||
|
|
||||||
Row IDs can be obtained from a query with ``with_row_id(True)``. This
|
|
||||||
API is currently supported only by local tables.
|
|
||||||
"""
|
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def fetch_blob_files(
|
def fetch_blob_files(
|
||||||
self, column: str, row_ids: Union[list[int], pa.Table]
|
self, column: str, row_ids: Union[list[int], pa.Table]
|
||||||
@@ -1778,7 +1748,7 @@ class Table(ABC):
|
|||||||
for faster reads.
|
for faster reads.
|
||||||
|
|
||||||
Arguments are passed onto Lance's
|
Arguments are passed onto Lance's
|
||||||
`lance.dataset.DatasetOptimizer.compact_files`.
|
[compact_files][lance.dataset.DatasetOptimizer.compact_files].
|
||||||
For most cases, the default should be fine.
|
For most cases, the default should be fine.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
@@ -1832,8 +1802,6 @@ class Table(ABC):
|
|||||||
retrain: bool, default False
|
retrain: bool, default False
|
||||||
This parameter is no longer used and is deprecated.
|
This parameter is no longer used and is deprecated.
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
The frequency an application should call optimize is based on the frequency of
|
The frequency an application should call optimize is based on the frequency of
|
||||||
data modifications. If data is frequently added, deleted, or updated then
|
data modifications. If data is frequently added, deleted, or updated then
|
||||||
optimize should be run frequently. A good rule of thumb is to run optimize if
|
optimize should be run frequently. A good rule of thumb is to run optimize if
|
||||||
@@ -1988,14 +1956,15 @@ class Table(ABC):
|
|||||||
change permanent you can use the `[Self::restore]` method.
|
change permanent you can use the `[Self::restore]` method.
|
||||||
|
|
||||||
Any operation that modifies the table will fail while the table is in a checked
|
Any operation that modifies the table will fail while the table is in a checked
|
||||||
out state. To return the table to a normal state use
|
out state.
|
||||||
`[Self::checkout_latest]`.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
version: int | str,
|
version: int | str,
|
||||||
The version to check out. A version number (`int`) or a tag
|
The version to check out. A version number (`int`) or a tag
|
||||||
(`str`) can be provided.
|
(`str`) can be provided.
|
||||||
|
|
||||||
|
To return the table to a normal state use `[Self::checkout_latest]`
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
@@ -2291,13 +2260,6 @@ class LanceTable(Table):
|
|||||||
) -> pa.LargeBinaryArray:
|
) -> pa.LargeBinaryArray:
|
||||||
return LOOP.run(self._table.fetch_blobs(column, row_ids))
|
return LOOP.run(self._table.fetch_blobs(column, row_ids))
|
||||||
|
|
||||||
def fetch_blob_ranges(
|
|
||||||
self,
|
|
||||||
column: str,
|
|
||||||
requests: Sequence[Tuple[int, int, int]],
|
|
||||||
) -> pa.LargeBinaryArray:
|
|
||||||
return LOOP.run(self._table.fetch_blob_ranges(column, list(requests)))
|
|
||||||
|
|
||||||
def fetch_blob_files(
|
def fetch_blob_files(
|
||||||
self, column: str, row_ids: Union[list[int], pa.Table]
|
self, column: str, row_ids: Union[list[int], pa.Table]
|
||||||
) -> "list[Optional[BlobFile]]":
|
) -> "list[Optional[BlobFile]]":
|
||||||
@@ -3060,12 +3022,10 @@ class LanceTable(Table):
|
|||||||
lower_case: bool = True,
|
lower_case: bool = True,
|
||||||
stem: bool = True,
|
stem: bool = True,
|
||||||
remove_stop_words: bool = True,
|
remove_stop_words: bool = True,
|
||||||
custom_stop_words: Optional[List[str]] = None,
|
|
||||||
ascii_folding: bool = True,
|
ascii_folding: bool = True,
|
||||||
ngram_min_length: int = 3,
|
ngram_min_length: int = 3,
|
||||||
ngram_max_length: int = 3,
|
ngram_max_length: int = 3,
|
||||||
prefix_only: bool = False,
|
prefix_only: bool = False,
|
||||||
block_size: int = 128,
|
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
):
|
):
|
||||||
"""Create a full-text search index on a column.
|
"""Create a full-text search index on a column.
|
||||||
@@ -3107,7 +3067,6 @@ class LanceTable(Table):
|
|||||||
"lower_case": lower_case,
|
"lower_case": lower_case,
|
||||||
"stem": stem,
|
"stem": stem,
|
||||||
"remove_stop_words": remove_stop_words,
|
"remove_stop_words": remove_stop_words,
|
||||||
"custom_stop_words": custom_stop_words,
|
|
||||||
"ascii_folding": ascii_folding,
|
"ascii_folding": ascii_folding,
|
||||||
"ngram_min_length": ngram_min_length,
|
"ngram_min_length": ngram_min_length,
|
||||||
"ngram_max_length": ngram_max_length,
|
"ngram_max_length": ngram_max_length,
|
||||||
@@ -3115,9 +3074,10 @@ class LanceTable(Table):
|
|||||||
}
|
}
|
||||||
else:
|
else:
|
||||||
tokenizer_configs = self.infer_tokenizer_configs(tokenizer_name)
|
tokenizer_configs = self.infer_tokenizer_configs(tokenizer_name)
|
||||||
tokenizer_configs["custom_stop_words"] = custom_stop_words
|
|
||||||
|
|
||||||
config = FTS(block_size=block_size, **tokenizer_configs)
|
config = FTS(
|
||||||
|
**tokenizer_configs,
|
||||||
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
LOOP.run(
|
LOOP.run(
|
||||||
@@ -3388,8 +3348,8 @@ class LanceTable(Table):
|
|||||||
fts_columns: Optional[Union[str, List[str]]] = None,
|
fts_columns: Optional[Union[str, List[str]]] = None,
|
||||||
) -> LanceQueryBuilder:
|
) -> LanceQueryBuilder:
|
||||||
"""Create a search query to find the nearest neighbors
|
"""Create a search query to find the nearest neighbors
|
||||||
of the given query vector. We currently support [vector search](https://lancedb.com/docs/search/vector-search/)
|
of the given query vector. We currently support [vector search][search]
|
||||||
and [full-text search](https://lancedb.com/docs/search/full-text-search/).
|
and [full-text search][search].
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
@@ -3419,9 +3379,8 @@ class LanceTable(Table):
|
|||||||
- *default None*.
|
- *default None*.
|
||||||
Acceptable types are: list, np.ndarray, PIL.Image.Image
|
Acceptable types are: list, np.ndarray, PIL.Image.Image
|
||||||
|
|
||||||
- If None then the
|
- If None then the select/[where][sql]/limit clauses are applied
|
||||||
select/[where][lancedb.query.LanceQueryBuilder.where]/limit clauses
|
to filter the table
|
||||||
are applied to filter the table
|
|
||||||
vector_column_name: str, optional
|
vector_column_name: str, optional
|
||||||
The name of the vector column to search.
|
The name of the vector column to search.
|
||||||
|
|
||||||
@@ -3815,8 +3774,6 @@ class LanceTable(Table):
|
|||||||
retrain: bool, default False
|
retrain: bool, default False
|
||||||
This parameter is no longer used and is deprecated.
|
This parameter is no longer used and is deprecated.
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
The frequency an application should call optimize is based on the frequency of
|
The frequency an application should call optimize is based on the frequency of
|
||||||
data modifications. If data is frequently added, deleted, or updated then
|
data modifications. If data is frequently added, deleted, or updated then
|
||||||
optimize should be run frequently. A good rule of thumb is to run optimize if
|
optimize should be run frequently. A good rule of thumb is to run optimize if
|
||||||
@@ -4689,24 +4646,7 @@ class AsyncTable:
|
|||||||
"""
|
"""
|
||||||
return AsyncQuery(self._inner.query(), self)
|
return AsyncQuery(self._inner.query(), self)
|
||||||
|
|
||||||
async def to_lance(self, **kwargs) -> lance.LanceDataset:
|
async def _to_lance(self, **kwargs) -> lance.LanceDataset:
|
||||||
"""Return the Lance dataset backing this table.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
**kwargs
|
|
||||||
Forwarded to `lance.dataset`.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
lance.LanceDataset
|
|
||||||
The Lance dataset at this table handle's version and branch.
|
|
||||||
|
|
||||||
Examples
|
|
||||||
--------
|
|
||||||
>>> async def get_lance_dataset(table):
|
|
||||||
... return await table.to_lance()
|
|
||||||
"""
|
|
||||||
try:
|
try:
|
||||||
import lance
|
import lance
|
||||||
except ImportError:
|
except ImportError:
|
||||||
@@ -4756,7 +4696,7 @@ class AsyncTable:
|
|||||||
return (await self.to_arrow()).to_pandas(**kwargs)
|
return (await self.to_arrow()).to_pandas(**kwargs)
|
||||||
if blob_mode == "bytes" and blob_v2_column_paths(schema):
|
if blob_mode == "bytes" and blob_v2_column_paths(schema):
|
||||||
return await self.query().to_pandas(blob_mode=blob_mode, **kwargs)
|
return await self.query().to_pandas(blob_mode=blob_mode, **kwargs)
|
||||||
return (await self.to_lance()).to_pandas(blob_mode=blob_mode, **kwargs)
|
return (await self._to_lance()).to_pandas(blob_mode=blob_mode, **kwargs)
|
||||||
|
|
||||||
async def to_arrow(self) -> pa.Table:
|
async def to_arrow(self) -> pa.Table:
|
||||||
"""Return the table as a pyarrow Table.
|
"""Return the table as a pyarrow Table.
|
||||||
@@ -5014,7 +4954,7 @@ class AsyncTable:
|
|||||||
progress: Optional[Union[bool, Callable, Any]] = None,
|
progress: Optional[Union[bool, Callable, Any]] = None,
|
||||||
write_parallelism: Optional[int] = None,
|
write_parallelism: Optional[int] = None,
|
||||||
) -> AddResult:
|
) -> AddResult:
|
||||||
"""Add more data to the [AsyncTable][lancedb.table.AsyncTable].
|
"""Add more data to the [Table](Table).
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -5216,8 +5156,8 @@ class AsyncTable:
|
|||||||
fts_columns: Optional[Union[str, List[str]]] = None,
|
fts_columns: Optional[Union[str, List[str]]] = None,
|
||||||
) -> Union[AsyncHybridQuery, AsyncFTSQuery, AsyncVectorQuery]:
|
) -> Union[AsyncHybridQuery, AsyncFTSQuery, AsyncVectorQuery]:
|
||||||
"""Create a search query to find the nearest neighbors
|
"""Create a search query to find the nearest neighbors
|
||||||
of the given query vector. We currently support [vector search](https://lancedb.com/docs/search/vector-search/)
|
of the given query vector. We currently support [vector search][search]
|
||||||
and [full-text search](https://lancedb.com/docs/search/full-text-search/).
|
and [full-text search][experimental-full-text-search].
|
||||||
|
|
||||||
All query options are defined in [AsyncQuery][lancedb.query.AsyncQuery].
|
All query options are defined in [AsyncQuery][lancedb.query.AsyncQuery].
|
||||||
|
|
||||||
@@ -5419,8 +5359,6 @@ class AsyncTable:
|
|||||||
async_query = async_query.where(query.filter)
|
async_query = async_query.where(query.filter)
|
||||||
if query.fast_search:
|
if query.fast_search:
|
||||||
async_query = async_query.fast_search()
|
async_query = async_query.fast_search()
|
||||||
if query.use_lsm is not None:
|
|
||||||
async_query = async_query.use_lsm(query.use_lsm)
|
|
||||||
if query.with_row_id:
|
if query.with_row_id:
|
||||||
async_query = async_query.with_row_id()
|
async_query = async_query.with_row_id()
|
||||||
if query.order_by:
|
if query.order_by:
|
||||||
@@ -5541,7 +5479,7 @@ class AsyncTable:
|
|||||||
when_not_matched_by_source_condition_expr=merge._when_not_matched_by_source_condition_expr,
|
when_not_matched_by_source_condition_expr=merge._when_not_matched_by_source_condition_expr,
|
||||||
timeout=merge._timeout,
|
timeout=merge._timeout,
|
||||||
use_index=merge._use_index,
|
use_index=merge._use_index,
|
||||||
use_lsm=merge._use_lsm,
|
use_lsm_write=merge._use_lsm_write,
|
||||||
validate_single_shard=merge._validate_single_shard,
|
validate_single_shard=merge._validate_single_shard,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@@ -5778,14 +5716,15 @@ class AsyncTable:
|
|||||||
change permanent you can use the `[Self::restore]` method.
|
change permanent you can use the `[Self::restore]` method.
|
||||||
|
|
||||||
Any operation that modifies the table will fail while the table is in a checked
|
Any operation that modifies the table will fail while the table is in a checked
|
||||||
out state. To return the table to a normal state use
|
out state.
|
||||||
`[Self::checkout_latest]`.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
version: int | str,
|
version: int | str,
|
||||||
The version to check out. A version number (`int`) or a tag
|
The version to check out. A version number (`int`) or a tag
|
||||||
(`str`) can be provided.
|
(`str`) can be provided.
|
||||||
|
|
||||||
|
To return the table to a normal state use `[Self::checkout_latest]`
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
await self._inner.checkout(version)
|
await self._inner.checkout(version)
|
||||||
@@ -5884,13 +5823,6 @@ class AsyncTable:
|
|||||||
column, _normalize_blob_row_ids(row_ids, column)
|
column, _normalize_blob_row_ids(row_ids, column)
|
||||||
)
|
)
|
||||||
|
|
||||||
async def fetch_blob_ranges(
|
|
||||||
self,
|
|
||||||
column: str,
|
|
||||||
requests: Sequence[Tuple[int, int, int]],
|
|
||||||
) -> pa.LargeBinaryArray:
|
|
||||||
return await self._inner.fetch_blob_ranges(column, list(requests))
|
|
||||||
|
|
||||||
async def fetch_blob_files(
|
async def fetch_blob_files(
|
||||||
self, column: str, row_ids: Union[list[int], pa.Table]
|
self, column: str, row_ids: Union[list[int], pa.Table]
|
||||||
) -> "list[Optional[BlobFile]]":
|
) -> "list[Optional[BlobFile]]":
|
||||||
@@ -5969,8 +5901,6 @@ class AsyncTable:
|
|||||||
retrain: bool, default False
|
retrain: bool, default False
|
||||||
This parameter is no longer used and is deprecated.
|
This parameter is no longer used and is deprecated.
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
The frequency an application should call optimize is based on the frequency of
|
The frequency an application should call optimize is based on the frequency of
|
||||||
data modifications. If data is frequently added, deleted, or updated then
|
data modifications. If data is frequently added, deleted, or updated then
|
||||||
optimize should be run frequently. A good rule of thumb is to run optimize if
|
optimize should be run frequently. A good rule of thumb is to run optimize if
|
||||||
@@ -6351,8 +6281,6 @@ class Branches:
|
|||||||
dry_run: bool, default False
|
dry_run: bool, default False
|
||||||
When True, only preview. When False, attempt the merge.
|
When True, only preview. When False, attempt the merge.
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
A rejected merge returns ``status="rejected"`` instead of raising.
|
A rejected merge returns ``status="rejected"`` instead of raising.
|
||||||
"""
|
"""
|
||||||
return LOOP.run(self._table.branches.merge(from_branch, dry_run))
|
return LOOP.run(self._table.branches.merge(from_branch, dry_run))
|
||||||
|
|||||||
@@ -184,75 +184,18 @@ def test_fetch_blobs_accepts_query_result():
|
|||||||
assert {blobs[i].as_py() for i in range(len(blobs))} == {b"gamma"}
|
assert {blobs[i].as_py() for i in range(len(blobs))} == {b"gamma"}
|
||||||
|
|
||||||
|
|
||||||
def test_fetch_blobs_preserves_null_and_empty_values():
|
def test_fetch_blobs_null_alignment():
|
||||||
table = _blob_table(
|
table = _blob_table(
|
||||||
"nulls",
|
"nulls",
|
||||||
[
|
[{"id": 1, "image": b"present"}, {"id": 2, "image": None}],
|
||||||
{"id": 1, "image": b"present"},
|
|
||||||
{"id": 2, "image": None},
|
|
||||||
{"id": 3, "image": b""},
|
|
||||||
],
|
|
||||||
)
|
)
|
||||||
by_id = _row_ids_by_id(table)
|
by_id = _row_ids_by_id(table)
|
||||||
request = [by_id[1], by_id[2], by_id[3], by_id[1]]
|
request = [by_id[1], by_id[2], by_id[1]]
|
||||||
blobs = table.fetch_blobs("image", request)
|
blobs = table.fetch_blobs("image", request)
|
||||||
assert len(blobs) == len(request)
|
assert len(blobs) == len(request)
|
||||||
assert blobs[0].as_py() == b"present"
|
assert blobs[0].as_py() == b"present"
|
||||||
assert blobs[1].as_py() is None
|
assert blobs[1].as_py() is None
|
||||||
assert blobs[2].as_py() == b""
|
assert blobs[2].as_py() == b"present"
|
||||||
assert blobs[3].as_py() == b"present"
|
|
||||||
|
|
||||||
|
|
||||||
def test_fetch_blob_ranges_aligns_repeated_ranges_and_nulls():
|
|
||||||
table = _blob_table(
|
|
||||||
"range_alignment",
|
|
||||||
[{"id": 1, "image": b"abcdefghij"}, {"id": 2, "image": None}],
|
|
||||||
)
|
|
||||||
by_id = _row_ids_by_id(table)
|
|
||||||
requests = [
|
|
||||||
(by_id[1], 2, 3),
|
|
||||||
(by_id[2], 0, 0),
|
|
||||||
(by_id[1], 0, 2),
|
|
||||||
(by_id[1], 2, 3),
|
|
||||||
(by_id[1], 10, 0),
|
|
||||||
]
|
|
||||||
|
|
||||||
ranges = table.fetch_blob_ranges("image", requests)
|
|
||||||
|
|
||||||
assert ranges.to_pylist() == [b"cde", None, b"ab", b"cde", b""]
|
|
||||||
|
|
||||||
|
|
||||||
def test_fetch_blob_ranges_validates_requests():
|
|
||||||
table = _blob_table("range_validation", [{"id": 1, "image": b"abc"}])
|
|
||||||
row_id = _row_ids_by_id(table)[1]
|
|
||||||
|
|
||||||
with pytest.raises(RuntimeError, match="exceeds blob size"):
|
|
||||||
table.fetch_blob_ranges("image", [(row_id, 2, 2)])
|
|
||||||
|
|
||||||
with pytest.raises(RuntimeError, match="offset \\+ length overflowed"):
|
|
||||||
table.fetch_blob_ranges("image", [(row_id, 2**64 - 1, 1)])
|
|
||||||
|
|
||||||
with pytest.raises(ValueError, match="row ids"):
|
|
||||||
table.fetch_blob_ranges("image", [(2**64 - 1, 0, 1)])
|
|
||||||
|
|
||||||
|
|
||||||
def test_fetch_blob_ranges_empty_requests_returns_empty_array():
|
|
||||||
table = _blob_table("range_empty", [{"id": 1, "image": b"x"}])
|
|
||||||
assert table.fetch_blob_ranges("image", []).to_pylist() == []
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_fetch_blob_ranges():
|
|
||||||
db = await lancedb.connect_async("memory:///")
|
|
||||||
schema = pa.schema([pa.field("id", pa.int64()), lancedb.blob("image")])
|
|
||||||
table = await db.create_table("range_async", schema=schema)
|
|
||||||
await table.add([{"id": 1, "image": b"abcdefghij"}])
|
|
||||||
hits = await table.query().with_row_id().to_arrow()
|
|
||||||
row_id = hits["_rowid"][0].as_py()
|
|
||||||
|
|
||||||
ranges = await table.fetch_blob_ranges("image", [(row_id, 1, 3), (row_id, 6, 2)])
|
|
||||||
|
|
||||||
assert ranges.to_pylist() == [b"bcd", b"gh"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_fetch_blobs_nested_path():
|
def test_fetch_blobs_nested_path():
|
||||||
|
|||||||
@@ -1333,42 +1333,6 @@ def test_transform_none_yields_dicts(lance_table):
|
|||||||
assert all("id" in item for item in items)
|
assert all("id" in item for item in items)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("configured", "detected", "expected"),
|
|
||||||
[(2, 8, 2), (None, 3, 3), (None, None, 1)],
|
|
||||||
)
|
|
||||||
def test_transform_parallelism_configures_executor(
|
|
||||||
lance_table, monkeypatch, configured, detected, expected
|
|
||||||
):
|
|
||||||
"""Explicit transform parallelism overrides the detected CPU count."""
|
|
||||||
real_executor = streaming.ThreadPoolExecutor
|
|
||||||
monkeypatch.setattr(streaming.os, "cpu_count", lambda: detected)
|
|
||||||
|
|
||||||
with patch.object(streaming, "ThreadPoolExecutor", wraps=real_executor) as executor:
|
|
||||||
list(
|
|
||||||
StreamingDataset(
|
|
||||||
lance_table,
|
|
||||||
num_splits=NUM_SPLITS,
|
|
||||||
shuffle_seed=SHUFFLE_SEED,
|
|
||||||
transform_parallelism=configured,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
assert executor.call_args_list[-1].kwargs["max_workers"] == expected
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("transform_parallelism", [0, -1])
|
|
||||||
def test_transform_parallelism_must_be_positive(lance_table, transform_parallelism):
|
|
||||||
with pytest.raises(
|
|
||||||
ValueError, match="transform_parallelism must be greater than 0"
|
|
||||||
):
|
|
||||||
StreamingDataset(
|
|
||||||
lance_table,
|
|
||||||
num_splits=NUM_SPLITS,
|
|
||||||
transform_parallelism=transform_parallelism,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filter_limits_rows(tmp_path):
|
def test_filter_limits_rows(tmp_path):
|
||||||
"""A filter expression is applied to the permutation so only matching rows
|
"""A filter expression is applied to the permutation so only matching rows
|
||||||
are yielded. IDs 0..59 pass ``id < 60``; the other 60 are excluded."""
|
are yielded. IDs 0..59 pass ``id < 60``; the other 60 are excluded."""
|
||||||
|
|||||||
@@ -219,48 +219,11 @@ def test_create_inverted_index(table, with_position):
|
|||||||
table.create_fts_index(
|
table.create_fts_index(
|
||||||
"text",
|
"text",
|
||||||
with_position=with_position,
|
with_position=with_position,
|
||||||
custom_stop_words=["puppy"],
|
|
||||||
name="custom_fts_index",
|
name="custom_fts_index",
|
||||||
)
|
)
|
||||||
indices = table.list_indices()
|
indices = table.list_indices()
|
||||||
fts_indices = [i for i in indices if i.index_type == "FTS"]
|
fts_indices = [i for i in indices if i.index_type == "FTS"]
|
||||||
assert any(i.name == "custom_fts_index" for i in fts_indices)
|
assert any(i.name == "custom_fts_index" for i in fts_indices)
|
||||||
assert fts_indices[0].index_details["custom_stop_words"] == ["puppy"]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("block_size", [128, 256])
|
|
||||||
def test_create_inverted_index_block_size(table, block_size):
|
|
||||||
table.create_index("text", config=FTS(block_size=block_size))
|
|
||||||
|
|
||||||
index = next(index for index in table.list_indices() if index.index_type == "FTS")
|
|
||||||
assert index.index_details["block_size"] == block_size
|
|
||||||
assert index.index_version == (2 if block_size == 128 else 3)
|
|
||||||
|
|
||||||
results = table.search("puppy").limit(5).to_list()
|
|
||||||
assert len(results) == 5
|
|
||||||
|
|
||||||
|
|
||||||
def test_create_inverted_index_rejects_invalid_block_size(table):
|
|
||||||
with pytest.raises(ValueError, match="128 or 256"):
|
|
||||||
table.create_index("text", config=FTS(block_size=129))
|
|
||||||
|
|
||||||
|
|
||||||
def test_custom_stop_words_list(table):
|
|
||||||
table.create_index(
|
|
||||||
"text",
|
|
||||||
config=FTS(stem=False, custom_stop_words=["lance"]),
|
|
||||||
)
|
|
||||||
|
|
||||||
assert table.list_indices()[0].index_details["custom_stop_words"] == ["lance"]
|
|
||||||
tokens = table.tokenize("the lance data", column="text")
|
|
||||||
assert [token.text for token in tokens] == ["the", "data"]
|
|
||||||
empty_tokens = ldb.tokenize("the lance data", stem=False, custom_stop_words=[])
|
|
||||||
assert [token.text for token in empty_tokens] == ["the", "lance", "data"]
|
|
||||||
with pytest.raises(TypeError, match=r"custom_stop_words.*int"):
|
|
||||||
ldb.tokenize(
|
|
||||||
"the lance data",
|
|
||||||
custom_stop_words=["lance", 42],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_search_fts(table):
|
def test_search_fts(table):
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ import lancedb
|
|||||||
import pyarrow as pa
|
import pyarrow as pa
|
||||||
import pytest
|
import pytest
|
||||||
from lancedb._lancedb import LsmWriteSpec
|
from lancedb._lancedb import LsmWriteSpec
|
||||||
from lancedb.index import FTS, IvfPq
|
|
||||||
|
|
||||||
SCHEMA = pa.schema(
|
SCHEMA = pa.schema(
|
||||||
[
|
[
|
||||||
@@ -103,35 +102,19 @@ def test_lsm_merge_insert_identity(tmp_path):
|
|||||||
assert result.num_rows == 2
|
assert result.num_rows == 2
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_merge_insert_use_lsm_false(tmp_path):
|
def test_lsm_merge_insert_use_lsm_write_false(tmp_path):
|
||||||
table = _bucket_table(tmp_path) # rows id = 1, 2, 3
|
table = _bucket_table(tmp_path) # rows id = 1, 2, 3
|
||||||
# use_lsm(False) opts out: the standard path runs and commits even with a spec.
|
# use_lsm_write(False) opts out: the standard path runs and commits.
|
||||||
result = (
|
result = (
|
||||||
table.merge_insert("id")
|
table.merge_insert("id")
|
||||||
.when_not_matched_insert_all()
|
.when_not_matched_insert_all()
|
||||||
.use_lsm(False)
|
.use_lsm_write(False)
|
||||||
.execute(_reader([3, 4, 5]))
|
.execute(_reader([3, 4, 5]))
|
||||||
)
|
)
|
||||||
assert result.num_inserted_rows == 2
|
assert result.num_inserted_rows == 2
|
||||||
assert table.count_rows() == 5
|
assert table.count_rows() == 5
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_merge_insert_use_lsm_true_without_spec_errors(tmp_path):
|
|
||||||
# A table with a primary key but no LSM write spec installed.
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
# use_lsm(True) demands MemWAL routing; without a spec it errors.
|
|
||||||
with pytest.raises(Exception, match="use_lsm"):
|
|
||||||
(
|
|
||||||
table.merge_insert("id")
|
|
||||||
.when_matched_update_all()
|
|
||||||
.when_not_matched_insert_all()
|
|
||||||
.use_lsm(True)
|
|
||||||
.execute(_reader([3, 4, 5]))
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_merge_insert_validate_single_shard_off(tmp_path):
|
def test_lsm_merge_insert_validate_single_shard_off(tmp_path):
|
||||||
table = _bucket_table(tmp_path)
|
table = _bucket_table(tmp_path)
|
||||||
result = (
|
result = (
|
||||||
@@ -144,20 +127,19 @@ def test_lsm_merge_insert_validate_single_shard_off(tmp_path):
|
|||||||
assert result.num_rows == 3
|
assert result.num_rows == 3
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_merge_insert_no_spec_uses_standard_path(tmp_path):
|
def test_lsm_merge_insert_use_lsm_write_true_requires_spec(tmp_path):
|
||||||
# A table with a primary key but no LSM write spec installed.
|
# A table with a primary key but no LSM write spec installed.
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
table = db.create_table("t", _reader([1, 2, 3]))
|
||||||
table.set_unenforced_primary_key("id")
|
table.set_unenforced_primary_key("id")
|
||||||
# With no spec, a default merge_insert uses the standard path and commits.
|
with pytest.raises(Exception, match="use_lsm_write"):
|
||||||
result = (
|
(
|
||||||
table.merge_insert("id")
|
table.merge_insert("id")
|
||||||
.when_matched_update_all()
|
.when_matched_update_all()
|
||||||
.when_not_matched_insert_all()
|
.when_not_matched_insert_all()
|
||||||
.execute(_reader([3, 4, 5]))
|
.use_lsm_write(True)
|
||||||
)
|
.execute(_reader([4]))
|
||||||
assert result.num_inserted_rows == 2
|
)
|
||||||
assert table.count_rows() == 5
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_merge_insert_rejects_on_not_primary_key(tmp_path):
|
def test_lsm_merge_insert_rejects_on_not_primary_key(tmp_path):
|
||||||
@@ -212,445 +194,3 @@ async def test_async_lsm_merge_insert(tmp_path):
|
|||||||
result = await builder.execute(_reader([3, 4, 5]))
|
result = await builder.execute(_reader([3, 4, 5]))
|
||||||
assert result.num_rows == 3
|
assert result.num_rows == 3
|
||||||
await table.close_lsm_writers()
|
await table.close_lsm_writers()
|
||||||
|
|
||||||
|
|
||||||
def _lsm_upsert(table, ids):
|
|
||||||
"""Upsert ``ids`` (value = 0..n) through the LSM merge_insert path."""
|
|
||||||
(
|
|
||||||
table.merge_insert([])
|
|
||||||
.when_matched_update_all()
|
|
||||||
.when_not_matched_insert_all()
|
|
||||||
.execute(_reader(ids))
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_sees_active_memtable(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3])) # base ids 1,2,3
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
|
|
||||||
_lsm_upsert(table, [4, 5]) # active memtable only, not committed to base
|
|
||||||
|
|
||||||
# Default read auto-routes through the LSM scanner: base ∪ active memtable.
|
|
||||||
lsm = table.search().to_arrow()
|
|
||||||
assert sorted(lsm["id"].to_pylist()) == [1, 2, 3, 4, 5]
|
|
||||||
|
|
||||||
# use_lsm(False) bypasses the MemWAL and reads the base table only.
|
|
||||||
base_only = table.search().use_lsm(False).to_arrow()
|
|
||||||
assert sorted(base_only["id"].to_pylist()) == [1, 2, 3]
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_dedup_newest_wins(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3])) # id 2 -> value 1
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
|
|
||||||
_lsm_upsert(table, [2, 3, 4]) # ids 2,3,4 -> values 0,1,2
|
|
||||||
|
|
||||||
lsm = table.search().to_arrow().sort_by("id")
|
|
||||||
assert lsm["id"].to_pylist() == [1, 2, 3, 4]
|
|
||||||
# id 1 from base (value 0); 2,3,4 from memtable (values 0,1,2).
|
|
||||||
assert lsm["value"].to_pylist() == [0, 0, 1, 2]
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_without_spec_reads_base(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
table.set_unenforced_primary_key("id") # no LSM write spec
|
|
||||||
|
|
||||||
# No spec: default read and use_lsm(False) both read the base table, no error.
|
|
||||||
assert sorted(table.search().to_arrow()["id"].to_pylist()) == [1, 2, 3]
|
|
||||||
assert sorted(table.search().use_lsm(False).to_arrow()["id"].to_pylist()) == [
|
|
||||||
1,
|
|
||||||
2,
|
|
||||||
3,
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_unsupported_shape_errors_without_use_lsm_false(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
_lsm_upsert(table, [4])
|
|
||||||
|
|
||||||
# with_row_id is unsupported by the LSM scanner; on a MemWAL table the default
|
|
||||||
# (auto-routed) read hard-errors instead of silently reading a stale base.
|
|
||||||
with pytest.raises(Exception):
|
|
||||||
table.search().with_row_id(True).to_arrow()
|
|
||||||
|
|
||||||
# use_lsm(False) is the escape hatch: it reads the base table only.
|
|
||||||
base = table.search().with_row_id(True).use_lsm(False).to_arrow()
|
|
||||||
assert sorted(base["id"].to_pylist()) == [1, 2, 3]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_lsm_read(tmp_path):
|
|
||||||
db = await lancedb.connect_async(
|
|
||||||
tmp_path, read_consistency_interval=timedelta(seconds=0)
|
|
||||||
)
|
|
||||||
table = await db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
await table.set_unenforced_primary_key("id")
|
|
||||||
await table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
|
|
||||||
builder = (
|
|
||||||
table.merge_insert([]).when_matched_update_all().when_not_matched_insert_all()
|
|
||||||
)
|
|
||||||
await builder.execute(_reader([4, 5]))
|
|
||||||
|
|
||||||
arrow = await table.query().to_arrow()
|
|
||||||
assert sorted(arrow["id"].to_pylist()) == [1, 2, 3, 4, 5]
|
|
||||||
|
|
||||||
|
|
||||||
VECTOR_DIM = 8
|
|
||||||
|
|
||||||
VECTOR_SCHEMA = pa.schema(
|
|
||||||
[
|
|
||||||
pa.field("id", pa.int64(), nullable=False),
|
|
||||||
pa.field("category", pa.utf8(), nullable=False),
|
|
||||||
pa.field("vector", pa.list_(pa.float32(), VECTOR_DIM), nullable=False),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _vector_reader(rows):
|
|
||||||
"""Rows are ``(id, category, [f32; VECTOR_DIM])`` tuples."""
|
|
||||||
batch = pa.RecordBatch.from_arrays(
|
|
||||||
[
|
|
||||||
pa.array([row[0] for row in rows], type=pa.int64()),
|
|
||||||
pa.array([row[1] for row in rows], type=pa.utf8()),
|
|
||||||
pa.array([row[2] for row in rows], type=pa.list_(pa.float32(), VECTOR_DIM)),
|
|
||||||
],
|
|
||||||
schema=VECTOR_SCHEMA,
|
|
||||||
)
|
|
||||||
return pa.RecordBatchReader.from_batches(VECTOR_SCHEMA, [batch])
|
|
||||||
|
|
||||||
|
|
||||||
def _vector_table(tmp_path):
|
|
||||||
"""Base table whose vector column is indexed so its rows are visible to the LSM
|
|
||||||
vector scanner (the base arm uses ``fast_search`` — indexed data only), plus an
|
|
||||||
unsharded LSM spec that maintains that index for the memtable.
|
|
||||||
|
|
||||||
Rows 1,2 are category ``a``, row 3 is ``b``, and 4..60 are filler ``c`` that
|
|
||||||
give the tiny IVF index enough data to train.
|
|
||||||
"""
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
rows = [
|
|
||||||
(
|
|
||||||
i,
|
|
||||||
"a" if i in (1, 2) else "b" if i == 3 else "c",
|
|
||||||
[float((i * 7 + j) % 13) for j in range(VECTOR_DIM)],
|
|
||||||
)
|
|
||||||
for i in range(1, 61)
|
|
||||||
]
|
|
||||||
table = db.create_table("t", _vector_reader(rows))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
# num_partitions=1 makes the search exhaustive within the single partition
|
|
||||||
# (deterministic); num_bits=4 keeps PQ training viable on a tiny dataset.
|
|
||||||
table.create_index(
|
|
||||||
"vector", config=IvfPq(num_partitions=1, num_sub_vectors=2, num_bits=4)
|
|
||||||
)
|
|
||||||
index_name = table.list_indices()[0].name
|
|
||||||
table.set_lsm_write_spec(
|
|
||||||
LsmWriteSpec.unsharded().with_maintained_indexes([index_name])
|
|
||||||
)
|
|
||||||
return table
|
|
||||||
|
|
||||||
|
|
||||||
def _vector_upsert(table, rows):
|
|
||||||
(
|
|
||||||
table.merge_insert([])
|
|
||||||
.when_matched_update_all()
|
|
||||||
.when_not_matched_insert_all()
|
|
||||||
.execute(_vector_reader(rows))
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_sees_memtable(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
# id 1000 lands in the active memtable, not committed to the base table.
|
|
||||||
_vector_upsert(table, [(1000, "a", [1.0] * VECTOR_DIM)])
|
|
||||||
|
|
||||||
query = [1.0] * VECTOR_DIM
|
|
||||||
# Vector search auto-routes through the LSM scanner: indexed base ∪ memtable.
|
|
||||||
ids = set(table.search(query).limit(100).to_arrow()["id"].to_pylist())
|
|
||||||
assert {1, 2, 3} <= ids # indexed base rows
|
|
||||||
assert 1000 in ids # in-flight memtable row
|
|
||||||
|
|
||||||
# use_lsm(False) bypasses the MemWAL, so the in-flight row is not visible.
|
|
||||||
base_ids = set(
|
|
||||||
table.search(query).use_lsm(False).limit(100).to_arrow()["id"].to_pylist()
|
|
||||||
)
|
|
||||||
assert {1, 2, 3} <= base_ids
|
|
||||||
assert 1000 not in base_ids
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_prefilter(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
# in-flight rows in both categories.
|
|
||||||
_vector_upsert(
|
|
||||||
table, [(1000, "a", [1.0] * VECTOR_DIM), (1001, "b", [1.0] * VECTOR_DIM)]
|
|
||||||
)
|
|
||||||
|
|
||||||
query = [1.0] * VECTOR_DIM
|
|
||||||
# The `where` predicate must apply as a prefilter across base ∪ memtable —
|
|
||||||
# regression test for the vector arm silently dropping the filter.
|
|
||||||
rows = table.search(query).where("category = 'a'").limit(100).to_arrow()
|
|
||||||
assert set(rows["id"].to_pylist()) == {1, 2, 1000}
|
|
||||||
assert set(rows["category"].to_pylist()) == {"a"}
|
|
||||||
|
|
||||||
# Sanity: without the filter, other categories are returned too.
|
|
||||||
unfiltered = set(table.search(query).limit(100).to_arrow()["category"].to_pylist())
|
|
||||||
assert unfiltered != {"a"}
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_plain_prefilter(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
_vector_upsert(
|
|
||||||
table, [(1000, "a", [1.0] * VECTOR_DIM), (1001, "b", [1.0] * VECTOR_DIM)]
|
|
||||||
)
|
|
||||||
|
|
||||||
# Plain scan + filter over base ∪ memtable: base 'a' rows 1,2 and memtable 1000.
|
|
||||||
rows = table.search().where("category = 'a'").to_arrow()
|
|
||||||
assert set(rows["id"].to_pylist()) == {1, 2, 1000}
|
|
||||||
|
|
||||||
|
|
||||||
FTS_SCHEMA = pa.schema(
|
|
||||||
[
|
|
||||||
pa.field("id", pa.int64(), nullable=False),
|
|
||||||
pa.field("text", pa.utf8(), nullable=False),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _fts_reader(rows):
|
|
||||||
"""Rows are ``(id, text)`` tuples."""
|
|
||||||
batch = pa.RecordBatch.from_arrays(
|
|
||||||
[
|
|
||||||
pa.array([row[0] for row in rows], type=pa.int64()),
|
|
||||||
pa.array([row[1] for row in rows], type=pa.utf8()),
|
|
||||||
],
|
|
||||||
schema=FTS_SCHEMA,
|
|
||||||
)
|
|
||||||
return pa.RecordBatchReader.from_batches(FTS_SCHEMA, [batch])
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_fts_sees_memtable(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table(
|
|
||||||
"t",
|
|
||||||
_fts_reader(
|
|
||||||
[
|
|
||||||
(1, "the quick brown fox"),
|
|
||||||
(2, "lazy dog sleeps"),
|
|
||||||
(3, "quick red fox"),
|
|
||||||
]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
# Native FTS index (tantivy is not compatible with the LSM memtable index).
|
|
||||||
table.create_index("text", config=FTS())
|
|
||||||
index_name = table.list_indices()[0].name
|
|
||||||
table.set_lsm_write_spec(
|
|
||||||
LsmWriteSpec.unsharded().with_maintained_indexes([index_name])
|
|
||||||
)
|
|
||||||
|
|
||||||
# in-flight doc 4 lands in the memtable's maintained FTS index.
|
|
||||||
(
|
|
||||||
table.merge_insert([])
|
|
||||||
.when_matched_update_all()
|
|
||||||
.when_not_matched_insert_all()
|
|
||||||
.execute(_fts_reader([(4, "brown fox jumps")]))
|
|
||||||
)
|
|
||||||
|
|
||||||
# Full-text search auto-routes through the LSM scanner: base ∪ memtable.
|
|
||||||
ids = set(
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text")
|
|
||||||
.limit(10)
|
|
||||||
.to_arrow()["id"]
|
|
||||||
.to_pylist()
|
|
||||||
)
|
|
||||||
assert ids == {1, 3, 4}
|
|
||||||
|
|
||||||
# Prefilter restricts the FTS results across both tiers.
|
|
||||||
filtered = set(
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text")
|
|
||||||
.where("id > 1")
|
|
||||||
.limit(10)
|
|
||||||
.to_arrow()["id"]
|
|
||||||
.to_pylist()
|
|
||||||
)
|
|
||||||
assert filtered == {3, 4}
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_unsupported_knobs_error(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
_vector_upsert(table, [(1000, "a", [1.0] * VECTOR_DIM)])
|
|
||||||
query = [1.0] * VECTOR_DIM
|
|
||||||
|
|
||||||
# distance_range and use_index(False) change the vector result set/mode, which
|
|
||||||
# the LSM scanner can't honor, so it hard-errors instead of silently returning
|
|
||||||
# wrong results (matching the prefilter / unsupported-shape contract).
|
|
||||||
with pytest.raises(Exception, match="distance_range"):
|
|
||||||
table.search(query).distance_range(0.0, 0.5).to_arrow()
|
|
||||||
with pytest.raises(Exception, match="use_index"):
|
|
||||||
table.search(query).bypass_vector_index().to_arrow()
|
|
||||||
|
|
||||||
# use_lsm(False) is the escape hatch: the base-only standard path honors them.
|
|
||||||
base = table.search(query).distance_range(0.0, 100.0).use_lsm(False).to_arrow()
|
|
||||||
assert 1000 not in set(base["id"].to_pylist())
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_limit_offset(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
_vector_upsert(table, [(1000, "a", [1.0] * VECTOR_DIM)])
|
|
||||||
query = [1.0] * VECTOR_DIM
|
|
||||||
# Lance's plan_vector over-fetches k + offset internally, so paging is correct:
|
|
||||||
# the second page is a full page (not truncated) and disjoint from the first.
|
|
||||||
page1 = table.search(query).limit(3).offset(0).to_arrow()["id"].to_pylist()
|
|
||||||
page2 = table.search(query).limit(3).offset(3).to_arrow()["id"].to_pylist()
|
|
||||||
assert len(page1) == 3
|
|
||||||
# If k ignored offset, page2 would be empty (limit - offset = 0); a full second
|
|
||||||
# page that differs from the first proves offset widens the candidate pool.
|
|
||||||
assert len(page2) == 3
|
|
||||||
assert set(page1) != set(page2)
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_postfilter_errors(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
_vector_upsert(table, [(1000, "a", [1.0] * VECTOR_DIM)])
|
|
||||||
query = [1.0] * VECTOR_DIM
|
|
||||||
# The LSM scanner always prefilters; a requested postfilter changes results, so
|
|
||||||
# it hard-errors rather than silently prefiltering.
|
|
||||||
with pytest.raises(Exception, match="postfilter"):
|
|
||||||
table.search(query).where("category = 'a'").postfilter().to_arrow()
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_projection_excludes_pk(tmp_path):
|
|
||||||
table = _vector_table(tmp_path)
|
|
||||||
_vector_upsert(table, [(1000, "a", [1.0] * VECTOR_DIM)])
|
|
||||||
# Selecting only 'category' must not leak the 'id' primary key Lance appends
|
|
||||||
# internally for dedup.
|
|
||||||
rows = table.search().select(["category"]).where("category = 'a'").to_arrow()
|
|
||||||
assert rows.column_names == ["category"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_fts_unmaintained_index_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _fts_reader([(1, "quick fox"), (2, "lazy dog")]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.create_index("text", config=FTS())
|
|
||||||
# No maintained indexes: the active memtable FTS arm cannot serve un-compacted
|
|
||||||
# docs, so the search would silently omit them — reject instead.
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
with pytest.raises(Exception, match="maintained"):
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text").to_arrow()
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_time_travel_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
pinned = table.version
|
|
||||||
table.add(_reader([4, 5])) # standard add commits a newer version
|
|
||||||
table.checkout(pinned) # detached head at the historical version
|
|
||||||
|
|
||||||
# The WAL/manifest expose current live state, so an LSM read at a pinned
|
|
||||||
# historical version is rejected.
|
|
||||||
with pytest.raises(Exception, match="time-travel"):
|
|
||||||
table.search().to_arrow()
|
|
||||||
# use_lsm(False) reads the base table at the pinned version.
|
|
||||||
base = table.search().use_lsm(False).to_arrow()
|
|
||||||
assert sorted(base["id"].to_pylist()) == [1, 2, 3]
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_take_row_ids_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _reader([1, 2, 3]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
_lsm_upsert(table, [4])
|
|
||||||
# take-by-row-id auto-routes through the LSM scanner, which has no stable _rowid,
|
|
||||||
# so it hard-errors instead of failing with an opaque column-not-found error.
|
|
||||||
with pytest.raises(Exception, match="row id"):
|
|
||||||
table.take_row_ids([0, 1]).to_arrow()
|
|
||||||
# use_lsm(False) is the escape hatch: it reads the base table.
|
|
||||||
base = table.take_row_ids([0, 1]).use_lsm(False).to_arrow()
|
|
||||||
assert base.num_rows == 2
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_fts_postfilter_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _fts_reader([(1, "quick fox"), (2, "lazy dog")]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.create_index("text", config=FTS())
|
|
||||||
index_name = table.list_indices()[0].name
|
|
||||||
table.set_lsm_write_spec(
|
|
||||||
LsmWriteSpec.unsharded().with_maintained_indexes([index_name])
|
|
||||||
)
|
|
||||||
# The LSM scanner always prefilters; postfilter on FTS changes result semantics,
|
|
||||||
# so it hard-errors (previously only the vector arm rejected it).
|
|
||||||
with pytest.raises(Exception, match="postfilter"):
|
|
||||||
(
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text")
|
|
||||||
.where("id > 0")
|
|
||||||
.postfilter()
|
|
||||||
.to_arrow()
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_fts_multiple_same_type_indexes_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _fts_reader([(1, "quick fox"), (2, "lazy dog")]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.create_index("text", config=FTS(), name="fts_a")
|
|
||||||
table.create_index("text", config=FTS(), name="fts_b", replace=False)
|
|
||||||
table.set_lsm_write_spec(
|
|
||||||
LsmWriteSpec.unsharded().with_maintained_indexes(["fts_a"])
|
|
||||||
)
|
|
||||||
# Two FTS indexes on the column: the base planner's chosen index is ambiguous, so
|
|
||||||
# the scanner can't pick a catch-up watermark and rejects rather than risk
|
|
||||||
# dropping rows the actually-used index has not caught up to.
|
|
||||||
with pytest.raises(Exception, match="multiple"):
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text").to_arrow()
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_vector_unmaintained_index_errors(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
rows = [
|
|
||||||
(i, "a", [float((i * 7 + j) % 13) for j in range(VECTOR_DIM)])
|
|
||||||
for i in range(1, 61)
|
|
||||||
]
|
|
||||||
table = db.create_table("t", _vector_reader(rows))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.create_index(
|
|
||||||
"vector", config=IvfPq(num_partitions=1, num_sub_vectors=2, num_bits=4)
|
|
||||||
)
|
|
||||||
# Spec with NO maintained indexes: the base vector index's catch-up is untracked,
|
|
||||||
# so the scanner rejects rather than risk dropping compacted-but-unindexed rows.
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded())
|
|
||||||
with pytest.raises(Exception, match="maintained"):
|
|
||||||
table.search([1.0] * VECTOR_DIM).to_arrow()
|
|
||||||
|
|
||||||
|
|
||||||
def test_lsm_read_fts_optimized_index_not_rejected(tmp_path):
|
|
||||||
db = lancedb.connect(tmp_path, read_consistency_interval=timedelta(seconds=0))
|
|
||||||
table = db.create_table("t", _fts_reader([(i, "quick fox") for i in range(1, 6)]))
|
|
||||||
table.set_unenforced_primary_key("id")
|
|
||||||
table.create_index("text", config=FTS())
|
|
||||||
table.add(_fts_reader([(i, "lazy fox") for i in range(6, 11)]))
|
|
||||||
table.optimize() # may split the FTS index into multiple physical segments
|
|
||||||
name = table.list_indices()[0].name
|
|
||||||
table.set_lsm_write_spec(LsmWriteSpec.unsharded().with_maintained_indexes([name]))
|
|
||||||
# Multiple physical segments of one logical index must not be miscounted as
|
|
||||||
# multiple indexes and rejected.
|
|
||||||
ids = set(
|
|
||||||
table.search("fox", query_type="fts", fts_columns="text")
|
|
||||||
.limit(20)
|
|
||||||
.to_arrow()["id"]
|
|
||||||
.to_pylist()
|
|
||||||
)
|
|
||||||
assert ids == set(range(1, 11))
|
|
||||||
|
|||||||
@@ -1136,61 +1136,3 @@ def test_take_offsets_empty_permutation(some_permutation: Permutation):
|
|||||||
result = some_permutation.take_offsets([])
|
result = some_permutation.take_offsets([])
|
||||||
|
|
||||||
assert result == []
|
assert result == []
|
||||||
|
|
||||||
|
|
||||||
def test_select_rowid(some_permutation: Permutation):
|
|
||||||
"""Test that _rowid can be selected alongside regular columns."""
|
|
||||||
perm_with_rowid = some_permutation.select_columns(["_rowid", "id"])
|
|
||||||
assert "_rowid" in perm_with_rowid.column_names
|
|
||||||
batches = list(perm_with_rowid.iter(100, skip_last_batch=False))
|
|
||||||
for batch in batches:
|
|
||||||
assert "_rowid" in batch[0]
|
|
||||||
|
|
||||||
|
|
||||||
def test_select_rowid_only(some_permutation: Permutation):
|
|
||||||
"""Test that _rowid can be selected as the sole column."""
|
|
||||||
perm_rowid_only = some_permutation.select_columns(["_rowid"])
|
|
||||||
assert perm_rowid_only.column_names == ["_rowid"]
|
|
||||||
batches = list(perm_rowid_only.iter(100, skip_last_batch=False))
|
|
||||||
assert len(batches) > 0
|
|
||||||
for batch in batches:
|
|
||||||
assert list(batch[0].keys()) == ["_rowid"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_select_rowid_not_in_default(some_permutation: Permutation):
|
|
||||||
"""Test that _rowid is NOT in the default column_names or schema."""
|
|
||||||
assert "_rowid" not in some_permutation.column_names
|
|
||||||
assert "_rowid" not in some_permutation.schema.names
|
|
||||||
|
|
||||||
|
|
||||||
def test_select_rowid_identity_permutation(mem_db):
|
|
||||||
"""Test that _rowid works with an identity permutation."""
|
|
||||||
tbl = mem_db.create_table(
|
|
||||||
"test_rowid_identity", pa.table({"id": range(10), "value": range(10)})
|
|
||||||
)
|
|
||||||
perm = Permutation.identity(tbl)
|
|
||||||
perm_with_rowid = perm.select_columns(["_rowid", "id"])
|
|
||||||
batches = list(perm_with_rowid.iter(10, skip_last_batch=False))
|
|
||||||
assert len(batches) == 1
|
|
||||||
assert "_rowid" in batches[0][0]
|
|
||||||
|
|
||||||
|
|
||||||
def test_rename_rowid(some_permutation: Permutation):
|
|
||||||
"""Test that _rowid can be selected and then renamed."""
|
|
||||||
perm_with_rowid = some_permutation.select_columns(["_rowid", "id"])
|
|
||||||
renamed = perm_with_rowid.rename_column("_rowid", "my_row_id")
|
|
||||||
assert "my_row_id" in renamed.column_names
|
|
||||||
assert "_rowid" not in renamed.column_names
|
|
||||||
batches = list(renamed.iter(100, skip_last_batch=False))
|
|
||||||
for batch in batches:
|
|
||||||
assert "my_row_id" in batch[0]
|
|
||||||
assert "_rowid" not in batch[0]
|
|
||||||
|
|
||||||
|
|
||||||
def test_remove_rowid_after_select(some_permutation: Permutation):
|
|
||||||
"""Test that _rowid can be selected and then removed."""
|
|
||||||
perm_with_rowid = some_permutation.select_columns(["_rowid", "id"])
|
|
||||||
assert "_rowid" in perm_with_rowid.column_names
|
|
||||||
perm_without_rowid = perm_with_rowid.remove_columns(["_rowid"])
|
|
||||||
assert "_rowid" not in perm_without_rowid.column_names
|
|
||||||
assert perm_without_rowid.column_names == ["id"]
|
|
||||||
|
|||||||
@@ -768,11 +768,7 @@ def test_table_create_indices():
|
|||||||
# Test create_fts_index with custom name (legacy method)
|
# Test create_fts_index with custom name (legacy method)
|
||||||
with pytest.warns(DeprecationWarning, match="create_fts_index"):
|
with pytest.warns(DeprecationWarning, match="create_fts_index"):
|
||||||
table.create_fts_index(
|
table.create_fts_index(
|
||||||
"text",
|
"text", wait_timeout=timedelta(seconds=2), name="custom_fts_idx"
|
||||||
wait_timeout=timedelta(seconds=2),
|
|
||||||
block_size=256,
|
|
||||||
custom_stop_words=["cloud"],
|
|
||||||
name="custom_fts_idx",
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# Test create_index with custom name (legacy form: vector_column_name kwarg)
|
# Test create_index with custom name (legacy form: vector_column_name kwarg)
|
||||||
@@ -795,8 +791,6 @@ def test_table_create_indices():
|
|||||||
fts_req = received_requests[1]
|
fts_req = received_requests[1]
|
||||||
assert "name" in fts_req
|
assert "name" in fts_req
|
||||||
assert fts_req["name"] == "custom_fts_idx"
|
assert fts_req["name"] == "custom_fts_idx"
|
||||||
assert fts_req["block_size"] == 256
|
|
||||||
assert fts_req["custom_stop_words"] == ["cloud"]
|
|
||||||
|
|
||||||
# Check vector index request has custom name
|
# Check vector index request has custom name
|
||||||
vector_req = received_requests[2]
|
vector_req = received_requests[2]
|
||||||
@@ -882,7 +876,7 @@ def test_remote_create_index_new_api():
|
|||||||
_warnings.simplefilter("error", DeprecationWarning)
|
_warnings.simplefilter("error", DeprecationWarning)
|
||||||
table.create_index("vector", config=IvfPq(distance_type="l2"))
|
table.create_index("vector", config=IvfPq(distance_type="l2"))
|
||||||
table.create_index("category", config=BTree())
|
table.create_index("category", config=BTree())
|
||||||
table.create_index("text", config=FTS(block_size=256))
|
table.create_index("text", config=FTS())
|
||||||
# IvfRq via new API
|
# IvfRq via new API
|
||||||
table.create_index("vector", config=IvfRq(distance_type="l2"))
|
table.create_index("vector", config=IvfRq(distance_type="l2"))
|
||||||
|
|
||||||
@@ -902,7 +896,6 @@ def test_remote_create_index_new_api():
|
|||||||
"vector",
|
"vector",
|
||||||
"vector",
|
"vector",
|
||||||
]
|
]
|
||||||
assert received_requests[2]["block_size"] == 256
|
|
||||||
|
|
||||||
|
|
||||||
def test_table_wait_for_index_timeout():
|
def test_table_wait_for_index_timeout():
|
||||||
|
|||||||
@@ -644,21 +644,6 @@ def test_cross_encoder_reranker_return_all(tmp_path):
|
|||||||
assert "_distance" in result.column_names
|
assert "_distance" in result.column_names
|
||||||
|
|
||||||
|
|
||||||
def test_answerdotai_reranker_return_all(tmp_path):
|
|
||||||
pytest.importorskip("rerankers")
|
|
||||||
reranker = AnswerdotaiRerankers(return_score="all")
|
|
||||||
table, schema = get_test_table(tmp_path)
|
|
||||||
query = "single player experience"
|
|
||||||
result = (
|
|
||||||
table.search(query, query_type="hybrid", vector_column_name="vector")
|
|
||||||
.rerank(reranker=reranker)
|
|
||||||
.to_arrow()
|
|
||||||
)
|
|
||||||
assert "_relevance_score" in result.column_names
|
|
||||||
assert "_score" in result.column_names
|
|
||||||
assert "_distance" in result.column_names
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Regression tests for LinearCombinationReranker scoring bugs (issue #3154)
|
# Regression tests for LinearCombinationReranker scoring bugs (issue #3154)
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -1257,53 +1257,6 @@ def test_branch_to_lance_targets_branch(tmp_path):
|
|||||||
assert table.to_lance().count_rows() == 1
|
assert table.to_lance().count_rows() == 1
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_to_lance(tmp_path):
|
|
||||||
pytest.importorskip("lance")
|
|
||||||
db = await lancedb.connect_async(tmp_path)
|
|
||||||
table = await db.create_table("t", [{"i": 1}])
|
|
||||||
|
|
||||||
dataset = await table.to_lance()
|
|
||||||
|
|
||||||
assert dataset.count_rows() == 1
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_branch_to_lance_targets_branch(tmp_path):
|
|
||||||
pytest.importorskip("lance")
|
|
||||||
db = await lancedb.connect_async(tmp_path)
|
|
||||||
table = await db.create_table("t", [{"i": 1}])
|
|
||||||
branch = await table.branches.create("exp")
|
|
||||||
await branch.add([{"i": 2}])
|
|
||||||
|
|
||||||
assert (await branch.to_lance()).count_rows() == 2
|
|
||||||
assert (await table.to_lance()).count_rows() == 1
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_to_lance_targets_checked_out_version(tmp_path):
|
|
||||||
pytest.importorskip("lance")
|
|
||||||
db = await lancedb.connect_async(tmp_path)
|
|
||||||
table = await db.create_table("t", [{"i": 1}])
|
|
||||||
version = await table.version()
|
|
||||||
await table.add([{"i": 2}])
|
|
||||||
checked_out = await db.open_table("t", version=version)
|
|
||||||
|
|
||||||
assert (await checked_out.to_lance()).count_rows() == 1
|
|
||||||
assert (await table.to_lance()).count_rows() == 2
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_async_to_lance_forwards_dataset_options(tmp_path):
|
|
||||||
pytest.importorskip("lance")
|
|
||||||
db = await lancedb.connect_async(tmp_path)
|
|
||||||
table = await db.create_table("t", [{"i": 1}])
|
|
||||||
|
|
||||||
dataset = await table.to_lance(default_scan_options={"with_row_id": True})
|
|
||||||
|
|
||||||
assert "_rowid" in dataset.schema.names
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_async_branches(tmp_path):
|
async def test_async_branches(tmp_path):
|
||||||
db = await lancedb.connect_async(tmp_path)
|
db = await lancedb.connect_async(tmp_path)
|
||||||
|
|||||||
+1
-7
@@ -59,11 +59,7 @@ pub fn extract_index_params(source: &Option<Bound<'_, PyAny>>) -> PyResult<Lance
|
|||||||
.ascii_folding(params.ascii_folding)
|
.ascii_folding(params.ascii_folding)
|
||||||
.ngram_min_length(params.ngram_min_length)
|
.ngram_min_length(params.ngram_min_length)
|
||||||
.ngram_max_length(params.ngram_max_length)
|
.ngram_max_length(params.ngram_max_length)
|
||||||
.ngram_prefix_only(params.prefix_only)
|
.ngram_prefix_only(params.prefix_only);
|
||||||
.custom_stop_words(params.custom_stop_words);
|
|
||||||
let inner_opts = inner_opts
|
|
||||||
.block_size(params.block_size)
|
|
||||||
.map_err(|err| PyValueError::new_err(err.to_string()))?;
|
|
||||||
Ok(LanceDbIndex::FTS(inner_opts))
|
Ok(LanceDbIndex::FTS(inner_opts))
|
||||||
}
|
}
|
||||||
"IvfFlat" => {
|
"IvfFlat" => {
|
||||||
@@ -207,12 +203,10 @@ struct FtsParams {
|
|||||||
lower_case: bool,
|
lower_case: bool,
|
||||||
stem: bool,
|
stem: bool,
|
||||||
remove_stop_words: bool,
|
remove_stop_words: bool,
|
||||||
custom_stop_words: Option<Vec<String>>,
|
|
||||||
ascii_folding: bool,
|
ascii_folding: bool,
|
||||||
ngram_min_length: u32,
|
ngram_min_length: u32,
|
||||||
ngram_max_length: u32,
|
ngram_max_length: u32,
|
||||||
prefix_only: bool,
|
prefix_only: bool,
|
||||||
block_size: usize,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(FromPyObject)]
|
#[derive(FromPyObject)]
|
||||||
|
|||||||
@@ -294,7 +294,6 @@ pub struct PyQueryRequest {
|
|||||||
pub select: PySelect,
|
pub select: PySelect,
|
||||||
pub fast_search: Option<bool>,
|
pub fast_search: Option<bool>,
|
||||||
pub with_row_id: Option<bool>,
|
pub with_row_id: Option<bool>,
|
||||||
pub use_lsm: Option<bool>,
|
|
||||||
pub column: Option<String>,
|
pub column: Option<String>,
|
||||||
pub query_vector: Option<PyQueryVectors>,
|
pub query_vector: Option<PyQueryVectors>,
|
||||||
pub minimum_nprobes: Option<usize>,
|
pub minimum_nprobes: Option<usize>,
|
||||||
@@ -325,7 +324,6 @@ impl From<AnyQuery> for PyQueryRequest {
|
|||||||
select: PySelect(query_request.select),
|
select: PySelect(query_request.select),
|
||||||
fast_search: Some(query_request.fast_search),
|
fast_search: Some(query_request.fast_search),
|
||||||
with_row_id: Some(query_request.with_row_id),
|
with_row_id: Some(query_request.with_row_id),
|
||||||
use_lsm: query_request.use_lsm,
|
|
||||||
column: None,
|
column: None,
|
||||||
query_vector: None,
|
query_vector: None,
|
||||||
minimum_nprobes: None,
|
minimum_nprobes: None,
|
||||||
@@ -350,7 +348,6 @@ impl From<AnyQuery> for PyQueryRequest {
|
|||||||
select: PySelect(vector_query.base.select),
|
select: PySelect(vector_query.base.select),
|
||||||
fast_search: Some(vector_query.base.fast_search),
|
fast_search: Some(vector_query.base.fast_search),
|
||||||
with_row_id: Some(vector_query.base.with_row_id),
|
with_row_id: Some(vector_query.base.with_row_id),
|
||||||
use_lsm: vector_query.base.use_lsm,
|
|
||||||
column: vector_query.column,
|
column: vector_query.column,
|
||||||
query_vector: Some(PyQueryVectors(vector_query.query_vector)),
|
query_vector: Some(PyQueryVectors(vector_query.query_vector)),
|
||||||
minimum_nprobes: Some(vector_query.minimum_nprobes),
|
minimum_nprobes: Some(vector_query.minimum_nprobes),
|
||||||
@@ -477,10 +474,6 @@ impl Query {
|
|||||||
self.inner = self.inner.clone().fast_search();
|
self.inner = self.inner.clone().fast_search();
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn with_row_id(&mut self) {
|
pub fn with_row_id(&mut self) {
|
||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
@@ -643,10 +636,6 @@ impl TakeQuery {
|
|||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[pyo3(signature = ())]
|
#[pyo3(signature = ())]
|
||||||
pub fn output_schema(self_: PyRef<'_, Self>) -> PyResult<Bound<'_, PyAny>> {
|
pub fn output_schema(self_: PyRef<'_, Self>) -> PyResult<Bound<'_, PyAny>> {
|
||||||
let inner = self_.inner.clone();
|
let inner = self_.inner.clone();
|
||||||
@@ -756,10 +745,6 @@ impl FTSQuery {
|
|||||||
self.inner = self.inner.clone().fast_search();
|
self.inner = self.inner.clone().fast_search();
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn with_row_id(&mut self) {
|
pub fn with_row_id(&mut self) {
|
||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
@@ -907,10 +892,6 @@ impl VectorQuery {
|
|||||||
self.inner = self.inner.clone().fast_search();
|
self.inner = self.inner.clone().fast_search();
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner = self.inner.clone().use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn with_row_id(&mut self) {
|
pub fn with_row_id(&mut self) {
|
||||||
self.inner = self.inner.clone().with_row_id();
|
self.inner = self.inner.clone().with_row_id();
|
||||||
}
|
}
|
||||||
@@ -1105,11 +1086,6 @@ impl HybridQuery {
|
|||||||
self.inner_fts.postfilter();
|
self.inner_fts.postfilter();
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn use_lsm(&mut self, enable: bool) {
|
|
||||||
self.inner_vec.use_lsm(enable);
|
|
||||||
self.inner_fts.use_lsm(enable);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn add_query_vector(&mut self, vector: Bound<'_, PyAny>) -> PyResult<()> {
|
pub fn add_query_vector(&mut self, vector: Bound<'_, PyAny>) -> PyResult<()> {
|
||||||
self.inner_vec.add_query_vector(vector)
|
self.inner_vec.add_query_vector(vector)
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-29
@@ -17,7 +17,7 @@ use arrow::{
|
|||||||
ffi_stream::ArrowArrayStreamReader,
|
ffi_stream::ArrowArrayStreamReader,
|
||||||
pyarrow::{FromPyArrow, PyArrowType, ToPyArrow},
|
pyarrow::{FromPyArrow, PyArrowType, ToPyArrow},
|
||||||
};
|
};
|
||||||
use lancedb::blob::{BlobFile, BlobRangeRequest};
|
use lancedb::blob::BlobFile;
|
||||||
use lancedb::index::scalar::FtsIndexBuilder;
|
use lancedb::index::scalar::FtsIndexBuilder;
|
||||||
use lancedb::table::{
|
use lancedb::table::{
|
||||||
AddDataMode, ColumnAlteration, Duration, FieldMetadataUpdate, FtsToken as LanceDbFtsToken,
|
AddDataMode, ColumnAlteration, Duration, FieldMetadataUpdate, FtsToken as LanceDbFtsToken,
|
||||||
@@ -520,7 +520,6 @@ impl From<LanceDbFtsToken> for FtsToken {
|
|||||||
lower_case = true,
|
lower_case = true,
|
||||||
stem = true,
|
stem = true,
|
||||||
remove_stop_words = true,
|
remove_stop_words = true,
|
||||||
custom_stop_words = None,
|
|
||||||
ascii_folding = true,
|
ascii_folding = true,
|
||||||
ngram_min_length = 3,
|
ngram_min_length = 3,
|
||||||
ngram_max_length = 3,
|
ngram_max_length = 3,
|
||||||
@@ -535,7 +534,6 @@ pub fn tokenize(
|
|||||||
lower_case: bool,
|
lower_case: bool,
|
||||||
stem: bool,
|
stem: bool,
|
||||||
remove_stop_words: bool,
|
remove_stop_words: bool,
|
||||||
custom_stop_words: Option<Vec<String>>,
|
|
||||||
ascii_folding: bool,
|
ascii_folding: bool,
|
||||||
ngram_min_length: u32,
|
ngram_min_length: u32,
|
||||||
ngram_max_length: u32,
|
ngram_max_length: u32,
|
||||||
@@ -557,8 +555,7 @@ pub fn tokenize(
|
|||||||
.ascii_folding(ascii_folding)
|
.ascii_folding(ascii_folding)
|
||||||
.ngram_min_length(ngram_min_length)
|
.ngram_min_length(ngram_min_length)
|
||||||
.ngram_max_length(ngram_max_length)
|
.ngram_max_length(ngram_max_length)
|
||||||
.ngram_prefix_only(prefix_only)
|
.ngram_prefix_only(prefix_only);
|
||||||
.custom_stop_words(custom_stop_words);
|
|
||||||
let tokens = lancedb_tokenize(&query, ¶ms).infer_error()?;
|
let tokens = lancedb_tokenize(&query, ¶ms).infer_error()?;
|
||||||
Ok(tokens.into_iter().map(FtsToken::from).collect())
|
Ok(tokens.into_iter().map(FtsToken::from).collect())
|
||||||
}
|
}
|
||||||
@@ -1104,27 +1101,6 @@ impl Table {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Read row-specific blob-local byte ranges in one planned operation.
|
|
||||||
#[pyo3(signature = (column, requests))]
|
|
||||||
pub fn fetch_blob_ranges(
|
|
||||||
self_: PyRef<'_, Self>,
|
|
||||||
column: String,
|
|
||||||
requests: Vec<(u64, u64, u64)>,
|
|
||||||
) -> PyResult<Bound<'_, PyAny>> {
|
|
||||||
let inner = self_.inner_ref()?.clone();
|
|
||||||
future_into_py(self_.py(), async move {
|
|
||||||
let requests = requests
|
|
||||||
.into_iter()
|
|
||||||
.map(|(row_id, offset, length)| BlobRangeRequest::new(row_id, offset, length))
|
|
||||||
.collect::<Vec<_>>();
|
|
||||||
let blobs: LargeBinaryArray = inner
|
|
||||||
.fetch_blob_ranges(column, requests)
|
|
||||||
.await
|
|
||||||
.infer_error()?;
|
|
||||||
Python::attach(|py| blobs.to_data().to_pyarrow(py).map(|obj| obj.unbind()))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Open lazy blob handles for `row_ids` from blob v2 column `column`.
|
/// Open lazy blob handles for `row_ids` from blob v2 column `column`.
|
||||||
#[pyo3(signature = (column, row_ids))]
|
#[pyo3(signature = (column, row_ids))]
|
||||||
pub fn fetch_blob_files(
|
pub fn fetch_blob_files(
|
||||||
@@ -1239,8 +1215,8 @@ impl Table {
|
|||||||
if let Some(use_index) = parameters.use_index {
|
if let Some(use_index) = parameters.use_index {
|
||||||
builder.use_index(use_index);
|
builder.use_index(use_index);
|
||||||
}
|
}
|
||||||
if let Some(use_lsm) = parameters.use_lsm {
|
if let Some(use_lsm_write) = parameters.use_lsm_write {
|
||||||
builder.use_lsm(use_lsm);
|
builder.use_lsm_write(use_lsm_write);
|
||||||
}
|
}
|
||||||
if let Some(validate_single_shard) = parameters.validate_single_shard {
|
if let Some(validate_single_shard) = parameters.validate_single_shard {
|
||||||
builder.validate_single_shard(validate_single_shard);
|
builder.validate_single_shard(validate_single_shard);
|
||||||
@@ -1478,7 +1454,7 @@ pub struct MergeInsertParams {
|
|||||||
when_not_matched_by_source_condition_expr: Option<PyExpr>,
|
when_not_matched_by_source_condition_expr: Option<PyExpr>,
|
||||||
timeout: Option<std::time::Duration>,
|
timeout: Option<std::time::Duration>,
|
||||||
use_index: Option<bool>,
|
use_index: Option<bool>,
|
||||||
use_lsm: Option<bool>,
|
use_lsm_write: Option<bool>,
|
||||||
validate_single_shard: Option<bool>,
|
validate_single_shard: Option<bool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+20
-26
@@ -1,17 +1,12 @@
|
|||||||
# Release process
|
# Release process
|
||||||
|
|
||||||
We release four `lancedb` packages: Python, Rust, Java, and Node.js.
|
There are five total packages we release. Four are the `lancedb` packages
|
||||||
|
for Python, Rust, Java, and Node.js. The other one is the legacy `vectordb`
|
||||||
|
package node.js.
|
||||||
|
|
||||||
All four share a single version number, defined by `current_version` in
|
The Python package is versioned and released separately from the Rust, Java, and Node.js
|
||||||
`.bumpversion.toml`. One `vX.Y.Z` tag releases all of them, so a breaking change
|
ones. For Node.js the release process is shared between `lancedb` and
|
||||||
in any SDK bumps the minor version for every SDK.
|
`vectordb` for now.
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> Python used to be versioned separately, under `python-vX.Y.Z` tags. It ran
|
|
||||||
> three minor versions ahead of the other SDKs, which made the two numbers hard
|
|
||||||
> to reason about. Both tracks were merged at `v0.37.0`: the Python line went
|
|
||||||
> `0.36` → `0.37` as usual, while Rust, Java, and Node.js jumped `0.33` → `0.37`
|
|
||||||
> to catch up. Tags before `v0.37.0` follow the old split scheme.
|
|
||||||
|
|
||||||
## Preview releases
|
## Preview releases
|
||||||
|
|
||||||
@@ -32,21 +27,20 @@ The release process uses a handful of GitHub actions to automate the process.
|
|||||||
┌─────────────────────┐
|
┌─────────────────────┐
|
||||||
│Create Release Commit│
|
│Create Release Commit│
|
||||||
└─┬───────────────────┘
|
└─┬───────────────────┘
|
||||||
│ ┌──────────────┐
|
│ ┌────────────┐ ┌──►Python GH Release
|
||||||
└──►(tag) vX.Y.Z ─┬─►│GitHub Release├───►GH Release
|
├──►(tag) python-vX.Y.Z ───►│PyPI Publish├─┤
|
||||||
│ └──────────────┘
|
│ └────────────┘ └──►Python Wheels
|
||||||
│ ┌────────────┐
|
│
|
||||||
├─►│PyPI Publish├─────►Python Wheels
|
│ ┌───────────┐
|
||||||
│ └────────────┘
|
└──►(tag) vX.Y.Z ───┬──────►│NPM Publish├──┬──►Rust/Node GH Release
|
||||||
│ ┌───────────┐
|
│ └───────────┘ │
|
||||||
├─►│NPM Publish├──────►NPM Packages
|
│ └──►NPM Packages
|
||||||
│ └───────────┘
|
│ ┌─────────────┐
|
||||||
│ ┌─────────────┐
|
├──────►│Cargo Publish├───►Cargo Release
|
||||||
├─►│Cargo Publish├────►Cargo Release
|
│ └─────────────┘
|
||||||
│ └─────────────┘
|
│ ┌─────────────┐
|
||||||
│ ┌─────────────┐
|
└──────►│Maven Publish├───►Java Maven Repo Release
|
||||||
└─►│Maven Publish├────►Java Maven Repo Release
|
└─────────────┘
|
||||||
└─────────────┘
|
|
||||||
```
|
```
|
||||||
|
|
||||||
To start a release, trigger a `Create Release Commit` action from
|
To start a release, trigger a `Create Release Commit` action from
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "lancedb"
|
name = "lancedb"
|
||||||
version = "0.37.1-beta.0"
|
version = "0.32.0-beta.2"
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
description = "LanceDB: A serverless, low-latency vector database for AI applications"
|
description = "LanceDB: A serverless, low-latency vector database for AI applications"
|
||||||
license.workspace = true
|
license.workspace = true
|
||||||
|
|||||||
@@ -76,12 +76,7 @@ async fn create_table(db: &Connection) -> Result<Table> {
|
|||||||
|
|
||||||
async fn create_index(table: &Table) -> Result<()> {
|
async fn create_index(table: &Table) -> Result<()> {
|
||||||
table
|
table
|
||||||
.create_index(
|
.create_index(&["doc"], Index::FTS(FtsIndexBuilder::default()))
|
||||||
&["doc"],
|
|
||||||
Index::FTS(
|
|
||||||
FtsIndexBuilder::default().custom_stop_words(Some(vec!["example".to_owned()])),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
.execute()
|
.execute()
|
||||||
.await?;
|
.await?;
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|||||||
+138
-84
@@ -11,42 +11,18 @@
|
|||||||
|
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
use arrow_array::LargeBinaryArray;
|
|
||||||
use arrow_array::builder::LargeBinaryBuilder;
|
use arrow_array::builder::LargeBinaryBuilder;
|
||||||
|
use arrow_array::{Array, LargeBinaryArray, RecordBatch, StructArray, UInt8Array, UInt64Array};
|
||||||
use arrow_schema::{DataType, Field, Schema};
|
use arrow_schema::{DataType, Field, Schema};
|
||||||
use lance::dataset::{BlobRangeRequest as LanceBlobRangeRequest, Dataset, WriteParams};
|
use lance::dataset::{Dataset, WriteParams};
|
||||||
use lance_arrow::FieldExt;
|
use lance_arrow::FieldExt;
|
||||||
|
use lance_core::datatypes::parse_field_path;
|
||||||
use lance_encoding::version::LanceFileVersion;
|
use lance_encoding::version::LanceFileVersion;
|
||||||
|
|
||||||
use crate::error::{Error, Result};
|
use crate::error::{Error, Result};
|
||||||
|
|
||||||
pub use lance::dataset::BlobFile;
|
pub use lance::dataset::BlobFile;
|
||||||
|
|
||||||
/// One row-specific blob range read request.
|
|
||||||
///
|
|
||||||
/// `row_id` is obtained from a query with row ids enabled.
|
|
||||||
/// `offset` and `length` are relative to the beginning of the logical blob.
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
||||||
pub struct BlobRangeRequest {
|
|
||||||
/// Row id of the blob value to read.
|
|
||||||
pub row_id: u64,
|
|
||||||
/// Byte offset from the beginning of the blob value.
|
|
||||||
pub offset: u64,
|
|
||||||
/// Number of bytes to read.
|
|
||||||
pub length: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl BlobRangeRequest {
|
|
||||||
/// Create a row-specific blob range request.
|
|
||||||
pub const fn new(row_id: u64, offset: u64, length: u64) -> Self {
|
|
||||||
Self {
|
|
||||||
row_id,
|
|
||||||
offset,
|
|
||||||
length,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Creates an Arrow field for a Lance blob v2 column.
|
/// Creates an Arrow field for a Lance blob v2 column.
|
||||||
///
|
///
|
||||||
/// `Struct<data, uri>` with the `lance.blob.v2` marker. Same layout Lance
|
/// `Struct<data, uri>` with the `lance.blob.v2` marker. Same layout Lance
|
||||||
@@ -169,57 +145,91 @@ pub(crate) fn ensure_blob_v2_column(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn ensure_all_row_ids_resolved(column: &str, requested: usize, resolved: usize) -> Result<()> {
|
/// Returns the leaf descriptor `StructArray` for `column` in a descriptor batch.
|
||||||
if requested == resolved {
|
fn leaf_descriptor_struct<'a>(batch: &'a RecordBatch, column: &str) -> Result<&'a StructArray> {
|
||||||
return Ok(());
|
let path = parse_field_path(column).map_err(|e| Error::InvalidInput {
|
||||||
}
|
message: format!("invalid blob column path '{column}': {e}"),
|
||||||
if resolved < requested {
|
})?;
|
||||||
Err(Error::InvalidInput {
|
let not_struct = || Error::Runtime {
|
||||||
message: format!(
|
message: format!("blob column '{column}' did not read back as a descriptor struct"),
|
||||||
"blob read for column '{column}' requested {requested} row ids but only {resolved} \
|
};
|
||||||
exist in the table; pass row ids collected from this table"
|
let mut current = batch
|
||||||
),
|
.column_by_name(&path[0])
|
||||||
})
|
.and_then(|c| c.as_any().downcast_ref::<StructArray>())
|
||||||
} else {
|
.ok_or_else(not_struct)?;
|
||||||
Err(Error::Runtime {
|
for segment in &path[1..] {
|
||||||
message: format!(
|
current = current
|
||||||
"blob read for column '{column}' returned {resolved} results for {requested} row ids"
|
.column_by_name(segment)
|
||||||
),
|
.and_then(|c| c.as_any().downcast_ref::<StructArray>())
|
||||||
})
|
.ok_or_else(not_struct)?;
|
||||||
}
|
}
|
||||||
|
Ok(current)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Materialize blob-local ranges (same length and order as `requests`, nulls preserved).
|
/// Null rows in `row_ids`, from a descriptor take.
|
||||||
pub(crate) async fn take_blob_ranges_aligned(
|
///
|
||||||
|
/// Lance `read_blobs` / `take_blobs` skip null rows (`kind == 0 && position == 0 && size == 0`).
|
||||||
|
/// TODO(lance): aligned read API would drop this pass.
|
||||||
|
async fn blob_null_mask(
|
||||||
dataset: &Arc<Dataset>,
|
dataset: &Arc<Dataset>,
|
||||||
column: &str,
|
column: &str,
|
||||||
requests: &[BlobRangeRequest],
|
row_ids: &[u64],
|
||||||
) -> Result<LargeBinaryArray> {
|
) -> Result<Vec<bool>> {
|
||||||
ensure_blob_v2_column(dataset.schema(), column)?;
|
let projection = dataset.schema().project(&[column])?;
|
||||||
if requests.is_empty() {
|
let descriptors = dataset.take_builder(row_ids, projection)?.execute().await?;
|
||||||
return Ok(LargeBinaryBuilder::new().finish());
|
if descriptors.num_rows() != row_ids.len() {
|
||||||
|
return Err(Error::InvalidInput {
|
||||||
|
message: format!(
|
||||||
|
"blob take for column '{column}' requested {} row ids but only {} exist in the \
|
||||||
|
table; pass row ids collected from this table",
|
||||||
|
row_ids.len(),
|
||||||
|
descriptors.num_rows()
|
||||||
|
),
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
let descriptor_struct = leaf_descriptor_struct(&descriptors, column)?;
|
||||||
|
let child = |name: &str| {
|
||||||
|
descriptor_struct
|
||||||
|
.column_by_name(name)
|
||||||
|
.ok_or_else(|| Error::Runtime {
|
||||||
|
message: format!("blob descriptor for '{column}' is missing the '{name}' field"),
|
||||||
|
})
|
||||||
|
};
|
||||||
|
let kinds = child("kind")?
|
||||||
|
.as_any()
|
||||||
|
.downcast_ref::<UInt8Array>()
|
||||||
|
.ok_or_else(|| Error::Runtime {
|
||||||
|
message: format!("blob descriptor 'kind' for '{column}' is not a UInt8 array"),
|
||||||
|
})?;
|
||||||
|
let positions = child("position")?
|
||||||
|
.as_any()
|
||||||
|
.downcast_ref::<UInt64Array>()
|
||||||
|
.ok_or_else(|| Error::Runtime {
|
||||||
|
message: format!("blob descriptor 'position' for '{column}' is not a UInt64 array"),
|
||||||
|
})?;
|
||||||
|
let sizes = child("size")?
|
||||||
|
.as_any()
|
||||||
|
.downcast_ref::<UInt64Array>()
|
||||||
|
.ok_or_else(|| Error::Runtime {
|
||||||
|
message: format!("blob descriptor 'size' for '{column}' is not a UInt64 array"),
|
||||||
|
})?;
|
||||||
|
|
||||||
let lance_requests = requests
|
// Match Lance `collect_blob_entries_v2` skip condition (`BlobKind::Inline` == 0).
|
||||||
|
Ok((0..descriptor_struct.len())
|
||||||
|
.map(|i| {
|
||||||
|
descriptor_struct.is_null(i)
|
||||||
|
|| kinds.is_null(i)
|
||||||
|
|| (kinds.value(i) == 0 && positions.value(i) == 0 && sizes.value(i) == 0)
|
||||||
|
})
|
||||||
|
.collect())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn non_null_row_ids(row_ids: &[u64], null_mask: &[bool]) -> Vec<u64> {
|
||||||
|
row_ids
|
||||||
.iter()
|
.iter()
|
||||||
.map(|request| LanceBlobRangeRequest::new(request.row_id, request.offset, request.length))
|
.zip(null_mask)
|
||||||
.collect::<Vec<_>>();
|
.filter_map(|(row_id, is_null)| (!is_null).then_some(*row_id))
|
||||||
let payloads = dataset
|
.collect()
|
||||||
.read_blob_ranges(column)?
|
|
||||||
.with_row_ids(lance_requests)
|
|
||||||
.preserve_order(true)
|
|
||||||
.execute()
|
|
||||||
.await?;
|
|
||||||
ensure_all_row_ids_resolved(column, requests.len(), payloads.len())?;
|
|
||||||
|
|
||||||
let mut builder = LargeBinaryBuilder::new();
|
|
||||||
for payload in payloads {
|
|
||||||
match payload.data {
|
|
||||||
Some(data) => builder.append_value(data),
|
|
||||||
None => builder.append_null(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Ok(builder.finish())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Materialize blob bytes for `row_ids` (same length and order, nulls preserved).
|
/// Materialize blob bytes for `row_ids` (same length and order, nulls preserved).
|
||||||
@@ -233,19 +243,38 @@ pub(crate) async fn take_blobs_aligned(
|
|||||||
return Ok(LargeBinaryBuilder::new().finish());
|
return Ok(LargeBinaryBuilder::new().finish());
|
||||||
}
|
}
|
||||||
|
|
||||||
let payloads = dataset
|
let null_mask = blob_null_mask(dataset, column, row_ids).await?;
|
||||||
.read_blobs(column)?
|
let non_null_row_ids = non_null_row_ids(row_ids, &null_mask);
|
||||||
.with_row_ids(row_ids.to_vec())
|
let non_null_count = non_null_row_ids.len();
|
||||||
.preserve_order(true)
|
let payloads = if non_null_count == 0 {
|
||||||
.execute()
|
Vec::new()
|
||||||
.await?;
|
} else {
|
||||||
ensure_all_row_ids_resolved(column, row_ids.len(), payloads.len())?;
|
dataset
|
||||||
|
.read_blobs(column)?
|
||||||
|
.with_row_ids(non_null_row_ids)
|
||||||
|
.preserve_order(true)
|
||||||
|
.execute()
|
||||||
|
.await?
|
||||||
|
};
|
||||||
|
|
||||||
|
if payloads.len() != non_null_count {
|
||||||
|
return Err(Error::Runtime {
|
||||||
|
message: format!(
|
||||||
|
"blob read for column '{column}' returned {} payloads for {} non-null rows",
|
||||||
|
payloads.len(),
|
||||||
|
non_null_count
|
||||||
|
),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
let mut builder = LargeBinaryBuilder::new();
|
let mut builder = LargeBinaryBuilder::new();
|
||||||
for payload in payloads {
|
let mut payload_idx = 0;
|
||||||
match payload.data {
|
for is_null in &null_mask {
|
||||||
Some(data) => builder.append_value(data),
|
if *is_null {
|
||||||
None => builder.append_null(),
|
builder.append_null();
|
||||||
|
} else {
|
||||||
|
builder.append_value(payloads[payload_idx].data.as_ref());
|
||||||
|
payload_idx += 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Ok(builder.finish())
|
Ok(builder.finish())
|
||||||
@@ -262,9 +291,34 @@ pub(crate) async fn take_blob_files_aligned(
|
|||||||
return Ok(Vec::new());
|
return Ok(Vec::new());
|
||||||
}
|
}
|
||||||
|
|
||||||
let handles = dataset.take_blobs(row_ids, column).await?;
|
let null_mask = blob_null_mask(dataset, column, row_ids).await?;
|
||||||
ensure_all_row_ids_resolved(column, row_ids.len(), handles.len())?;
|
let non_null_row_ids = non_null_row_ids(row_ids, &null_mask);
|
||||||
Ok(handles)
|
let handles = if non_null_row_ids.is_empty() {
|
||||||
|
Vec::new()
|
||||||
|
} else {
|
||||||
|
dataset.take_blobs(&non_null_row_ids, column).await?
|
||||||
|
};
|
||||||
|
if handles.len() != non_null_row_ids.len() {
|
||||||
|
return Err(Error::Runtime {
|
||||||
|
message: format!(
|
||||||
|
"blob take for column '{column}' returned {} handles for {} non-null rows",
|
||||||
|
handles.len(),
|
||||||
|
non_null_row_ids.len()
|
||||||
|
),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut handles = handles.into_iter();
|
||||||
|
Ok(null_mask
|
||||||
|
.iter()
|
||||||
|
.map(|is_null| {
|
||||||
|
if *is_null {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
Some(handles.next().unwrap())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.collect())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
|
|||||||
@@ -54,26 +54,7 @@ pub enum Index {
|
|||||||
/// substrings of the raw bytes, unlike the tokenized [`Index::FTS`] index.
|
/// substrings of the raw bytes, unlike the tokenized [`Index::FTS`] index.
|
||||||
Fm(FmIndexBuilder),
|
Fm(FmIndexBuilder),
|
||||||
|
|
||||||
/// Full text search index using BM25.
|
/// Full text search index using bm25.
|
||||||
///
|
|
||||||
/// The posting block size defaults to 128. Supported values are 128 and 256;
|
|
||||||
/// a value of 256 uses the experimental FTS V3 format and may introduce
|
|
||||||
/// breaking changes.
|
|
||||||
///
|
|
||||||
/// ```
|
|
||||||
/// use lancedb::index::{Index, scalar::FtsIndexBuilder};
|
|
||||||
///
|
|
||||||
/// # async fn create_fts_index(
|
|
||||||
/// # table: &lancedb::Table,
|
|
||||||
/// # ) -> Result<(), Box<dyn std::error::Error>> {
|
|
||||||
/// let params = FtsIndexBuilder::default().block_size(256)?;
|
|
||||||
/// table
|
|
||||||
/// .create_index(&["text"], Index::FTS(params))
|
|
||||||
/// .execute()
|
|
||||||
/// .await?;
|
|
||||||
/// # Ok(())
|
|
||||||
/// # }
|
|
||||||
/// ```
|
|
||||||
FTS(FtsIndexBuilder),
|
FTS(FtsIndexBuilder),
|
||||||
|
|
||||||
/// IVF index
|
/// IVF index
|
||||||
|
|||||||
@@ -167,11 +167,6 @@
|
|||||||
//! # }
|
//! # }
|
||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
// The MemWAL LSM read path (`table::query::lsm`) deepens the `create_plan` future's
|
|
||||||
// type graph enough to overflow the default trait-recursion limit while evaluating
|
|
||||||
// auto-traits (`Send`) through the Linux io_uring build's moka cache. Raise it.
|
|
||||||
#![recursion_limit = "256"]
|
|
||||||
|
|
||||||
pub mod arrow;
|
pub mod arrow;
|
||||||
pub mod blob;
|
pub mod blob;
|
||||||
pub mod connection;
|
pub mod connection;
|
||||||
@@ -201,7 +196,7 @@ use std::{fmt::Display, str::FromStr};
|
|||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
pub use blob::{BlobRangeRequest, blob, is_blob};
|
pub use blob::{blob, is_blob};
|
||||||
pub use connection::{ConnectNamespaceBuilder, Connection};
|
pub use connection::{ConnectNamespaceBuilder, Connection};
|
||||||
pub use error::{Error, Result};
|
pub use error::{Error, Result};
|
||||||
use lance_index::vector::ApproxMode as LanceApproxMode;
|
use lance_index::vector::ApproxMode as LanceApproxMode;
|
||||||
|
|||||||
@@ -523,26 +523,6 @@ pub trait QueryBase {
|
|||||||
///
|
///
|
||||||
/// This allows ordering query results by one or more columns in either ascending or descending order.
|
/// This allows ordering query results by one or more columns in either ascending or descending order.
|
||||||
fn order_by(self, ordering: Option<Vec<ColumnOrdering>>) -> Self;
|
fn order_by(self, ordering: Option<Vec<ColumnOrdering>>) -> Self;
|
||||||
|
|
||||||
/// Control MemWAL read routing for this query.
|
|
||||||
///
|
|
||||||
/// By default (unset), when the table carries a MemWAL write spec (see
|
|
||||||
/// [`crate::Table::set_lsm_write_spec`]), reads are routed through the LSM
|
|
||||||
/// scanner so they also return data written via the `merge_insert` LSM path
|
|
||||||
/// that has not yet been compacted into the base table (active/frozen
|
|
||||||
/// memtables and flushed generations); a table without a spec reads the base
|
|
||||||
/// table.
|
|
||||||
///
|
|
||||||
/// - `use_lsm(true)` forces LSM routing and errors if the table has no
|
|
||||||
/// MemWAL write spec.
|
|
||||||
/// - `use_lsm(false)` bypasses the MemWAL and reads the base table only,
|
|
||||||
/// even when a spec is present.
|
|
||||||
///
|
|
||||||
/// Note: the LSM scanner does not support every query shape (e.g. reranking,
|
|
||||||
/// hybrid search, `order_by`). On a MemWAL table those shapes error unless
|
|
||||||
/// `use_lsm(false)` is set, because a base-only read would silently
|
|
||||||
/// exclude un-compacted MemWAL data.
|
|
||||||
fn use_lsm(self, enable: bool) -> Self;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait HasQuery {
|
pub trait HasQuery {
|
||||||
@@ -613,11 +593,6 @@ impl<T: HasQuery> QueryBase for T {
|
|||||||
self.mut_query().order_by = ordering;
|
self.mut_query().order_by = ordering;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
fn use_lsm(mut self, enable: bool) -> Self {
|
|
||||||
self.mut_query().use_lsm = Some(enable);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Options for controlling the execution of a query
|
/// Options for controlling the execution of a query
|
||||||
@@ -869,20 +844,6 @@ pub struct QueryRequest {
|
|||||||
///
|
///
|
||||||
/// This allows ordering query results by one or more columns in either ascending or descending order.
|
/// This allows ordering query results by one or more columns in either ascending or descending order.
|
||||||
pub order_by: Option<Vec<ColumnOrdering>>,
|
pub order_by: Option<Vec<ColumnOrdering>>,
|
||||||
|
|
||||||
/// Controls MemWAL read routing. When unset (the default), a query against a
|
|
||||||
/// table that carries a MemWAL write spec (see
|
|
||||||
/// [`crate::Table::set_lsm_write_spec`]) is routed through the LSM scanner so
|
|
||||||
/// it also sees data written via the `merge_insert` LSM path that has not yet
|
|
||||||
/// been compacted into the base table — the active and frozen in-memory
|
|
||||||
/// memtables and the flushed (L0) generations, deduplicated by primary key
|
|
||||||
/// against the base table (newest generation wins); a table without a spec
|
|
||||||
/// reads the base table.
|
|
||||||
///
|
|
||||||
/// - `Some(true)` forces LSM routing and errors if the table has no MemWAL
|
|
||||||
/// write spec.
|
|
||||||
/// - `Some(false)` reads only the base table, bypassing the MemWAL.
|
|
||||||
pub use_lsm: Option<bool>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for QueryRequest {
|
impl Default for QueryRequest {
|
||||||
@@ -901,7 +862,6 @@ impl Default for QueryRequest {
|
|||||||
norm: None,
|
norm: None,
|
||||||
disable_scoring_autoprojection: false,
|
disable_scoring_autoprojection: false,
|
||||||
order_by: None,
|
order_by: None,
|
||||||
use_lsm: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -617,11 +617,6 @@ impl<S: HttpSend> RemoteTable<S> {
|
|||||||
) -> Result<()> {
|
) -> Result<()> {
|
||||||
params.check_filter()?;
|
params.check_filter()?;
|
||||||
body["prefilter"] = params.prefilter.into();
|
body["prefilter"] = params.prefilter.into();
|
||||||
// Only forward use_lsm when explicitly set; a server that predates it
|
|
||||||
// ignores the field and routes as it would by default.
|
|
||||||
if let Some(use_lsm) = params.use_lsm {
|
|
||||||
body["use_lsm"] = serde_json::Value::Bool(use_lsm);
|
|
||||||
}
|
|
||||||
if let Some(offset) = params.offset {
|
if let Some(offset) = params.offset {
|
||||||
body["offset"] = serde_json::Value::Number(serde_json::Number::from(offset));
|
body["offset"] = serde_json::Value::Number(serde_json::Number::from(offset));
|
||||||
}
|
}
|
||||||
@@ -1631,21 +1626,9 @@ impl<S: HttpSend> BaseTable for RemoteTable<S> {
|
|||||||
let (request_id, response) = self.send(request, true).await?;
|
let (request_id, response) = self.send(request, true).await?;
|
||||||
let response = self.check_table_response(&request_id, response).await?;
|
let response = self.check_table_response(&request_id, response).await?;
|
||||||
|
|
||||||
// Servers report the creation time either as an RFC 3339 `timestamp`
|
|
||||||
// (direct-table path) or as `timestamp_millis` in milliseconds since
|
|
||||||
// epoch (namespace-backed path), and may omit `metadata`.
|
|
||||||
#[derive(Deserialize)]
|
|
||||||
struct VersionEntry {
|
|
||||||
version: u64,
|
|
||||||
timestamp: Option<DateTime<Utc>>,
|
|
||||||
timestamp_millis: Option<i64>,
|
|
||||||
#[serde(default)]
|
|
||||||
metadata: std::collections::BTreeMap<String, String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
struct ListVersionsResponse {
|
struct ListVersionsResponse {
|
||||||
versions: Vec<VersionEntry>,
|
versions: Vec<Version>,
|
||||||
}
|
}
|
||||||
|
|
||||||
let body = response.text().await.err_to_http(request_id.clone())?;
|
let body = response.text().await.err_to_http(request_id.clone())?;
|
||||||
@@ -1656,37 +1639,11 @@ impl<S: HttpSend> BaseTable for RemoteTable<S> {
|
|||||||
err, body
|
err, body
|
||||||
)
|
)
|
||||||
.into(),
|
.into(),
|
||||||
request_id: request_id.clone(),
|
request_id,
|
||||||
status_code: None,
|
status_code: None,
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
body.versions
|
Ok(body.versions)
|
||||||
.into_iter()
|
|
||||||
.map(|entry| {
|
|
||||||
let timestamp = entry
|
|
||||||
.timestamp
|
|
||||||
.or_else(|| {
|
|
||||||
entry
|
|
||||||
.timestamp_millis
|
|
||||||
.and_then(DateTime::<Utc>::from_timestamp_millis)
|
|
||||||
})
|
|
||||||
.ok_or_else(|| Error::Http {
|
|
||||||
source: format!(
|
|
||||||
"list_versions response for version {} has neither a valid \
|
|
||||||
`timestamp` nor `timestamp_millis` field",
|
|
||||||
entry.version
|
|
||||||
)
|
|
||||||
.into(),
|
|
||||||
request_id: request_id.clone(),
|
|
||||||
status_code: None,
|
|
||||||
})?;
|
|
||||||
Ok(Version {
|
|
||||||
version: entry.version,
|
|
||||||
timestamp,
|
|
||||||
metadata: entry.metadata,
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.collect()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn schema(&self) -> Result<SchemaRef> {
|
async fn schema(&self) -> Result<SchemaRef> {
|
||||||
@@ -2886,10 +2843,6 @@ struct MergeInsertRequest {
|
|||||||
// (the default is true)
|
// (the default is true)
|
||||||
#[serde(skip_serializing_if = "is_true")]
|
#[serde(skip_serializing_if = "is_true")]
|
||||||
use_index: bool,
|
use_index: bool,
|
||||||
// Only serialize use_lsm when explicitly set (Some); a server that predates
|
|
||||||
// it ignores the field and routes as it would by default.
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
use_lsm: Option<bool>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_true(b: &bool) -> bool {
|
fn is_true(b: &bool) -> bool {
|
||||||
@@ -2941,7 +2894,6 @@ impl TryFrom<MergeInsertBuilder> for MergeInsertRequest {
|
|||||||
when_not_matched_by_source_delete_filt,
|
when_not_matched_by_source_delete_filt,
|
||||||
// Only serialize use_index when it's false for backwards compatibility
|
// Only serialize use_index when it's false for backwards compatibility
|
||||||
use_index: value.use_index,
|
use_index: value.use_index,
|
||||||
use_lsm: value.use_lsm,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -4544,28 +4496,6 @@ mod tests {
|
|||||||
serde_json::to_value(InvertedIndexParams::default()).unwrap(),
|
serde_json::to_value(InvertedIndexParams::default()).unwrap(),
|
||||||
Index::FTS(Default::default()),
|
Index::FTS(Default::default()),
|
||||||
),
|
),
|
||||||
(
|
|
||||||
"FTS",
|
|
||||||
{
|
|
||||||
let mut body = serde_json::to_value(InvertedIndexParams::default()).unwrap();
|
|
||||||
body["block_size"] = 256.into();
|
|
||||||
body
|
|
||||||
},
|
|
||||||
Index::FTS(InvertedIndexParams::default().block_size(256).unwrap()),
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"FTS",
|
|
||||||
{
|
|
||||||
let mut body = serde_json::to_value(InvertedIndexParams::default()).unwrap();
|
|
||||||
body["custom_stop_words"] = json!(["cat", " cat ", "CAT"]);
|
|
||||||
body
|
|
||||||
},
|
|
||||||
Index::FTS(InvertedIndexParams::default().custom_stop_words(Some(vec![
|
|
||||||
"cat".to_string(),
|
|
||||||
" cat ".to_string(),
|
|
||||||
"CAT".to_string(),
|
|
||||||
]))),
|
|
||||||
),
|
|
||||||
];
|
];
|
||||||
|
|
||||||
for (index_type, expected_body, index) in cases {
|
for (index_type, expected_body, index) in cases {
|
||||||
@@ -5097,9 +5027,8 @@ mod tests {
|
|||||||
"max_token_length": 40,
|
"max_token_length": 40,
|
||||||
"lower_case": true,
|
"lower_case": true,
|
||||||
"stem": false,
|
"stem": false,
|
||||||
"remove_stop_words": true,
|
"remove_stop_words": false,
|
||||||
"ascii_folding": true,
|
"ascii_folding": true,
|
||||||
"custom_stop_words": ["hello"],
|
|
||||||
})
|
})
|
||||||
.to_string();
|
.to_string();
|
||||||
let table = Table::new_with_handler("my_table", move |request| {
|
let table = Table::new_with_handler("my_table", move |request| {
|
||||||
@@ -5137,6 +5066,10 @@ mod tests {
|
|||||||
assert_eq!(
|
assert_eq!(
|
||||||
tokens,
|
tokens,
|
||||||
vec![
|
vec![
|
||||||
|
FtsToken {
|
||||||
|
text: "hello".to_string(),
|
||||||
|
position: 0,
|
||||||
|
},
|
||||||
FtsToken {
|
FtsToken {
|
||||||
text: "こんにちは".to_string(),
|
text: "こんにちは".to_string(),
|
||||||
position: 1,
|
position: 1,
|
||||||
@@ -5294,56 +5227,6 @@ mod tests {
|
|||||||
// assert_eq!(versions, expected);
|
// assert_eq!(versions, expected);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Namespace-backed servers report `timestamp_millis` instead of
|
|
||||||
/// `timestamp`, and may omit `metadata` entirely.
|
|
||||||
#[tokio::test]
|
|
||||||
async fn test_list_versions_timestamp_millis() {
|
|
||||||
let table = Table::new_with_handler("my_table", |request| {
|
|
||||||
assert_eq!(request.method(), "POST");
|
|
||||||
assert_eq!(request.url().path(), "/v1/table/my_table/version/list/");
|
|
||||||
|
|
||||||
let response_body = serde_json::json!({
|
|
||||||
"versions": [
|
|
||||||
{
|
|
||||||
"version": 1,
|
|
||||||
"manifest_path": "path/to/_versions/1.manifest",
|
|
||||||
"timestamp_millis": 1704067200000i64,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"version": 2,
|
|
||||||
"manifest_path": "path/to/_versions/2.manifest",
|
|
||||||
"timestamp_millis": 1706745600000i64,
|
|
||||||
"metadata": {"key": "value"},
|
|
||||||
},
|
|
||||||
]
|
|
||||||
});
|
|
||||||
let response_body = serde_json::to_string(&response_body).unwrap();
|
|
||||||
|
|
||||||
http::Response::builder()
|
|
||||||
.status(200)
|
|
||||||
.body(response_body)
|
|
||||||
.unwrap()
|
|
||||||
});
|
|
||||||
|
|
||||||
let versions = table.list_versions().await.unwrap();
|
|
||||||
assert_eq!(versions.len(), 2);
|
|
||||||
assert_eq!(versions[0].version, 1);
|
|
||||||
assert_eq!(
|
|
||||||
versions[0].timestamp,
|
|
||||||
"2024-01-01T00:00:00Z".parse::<DateTime<Utc>>().unwrap()
|
|
||||||
);
|
|
||||||
assert!(versions[0].metadata.is_empty());
|
|
||||||
assert_eq!(versions[1].version, 2);
|
|
||||||
assert_eq!(
|
|
||||||
versions[1].timestamp,
|
|
||||||
"2024-02-01T00:00:00Z".parse::<DateTime<Utc>>().unwrap()
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
versions[1].metadata.get("key").map(String::as_str),
|
|
||||||
Some("value")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_index_stats() {
|
async fn test_index_stats() {
|
||||||
let table = Table::new_with_handler("my_table", |request| {
|
let table = Table::new_with_handler("my_table", |request| {
|
||||||
|
|||||||
+9
-102
@@ -21,7 +21,6 @@ use lance::dataset::WriteMode;
|
|||||||
use lance::dataset::builder::DatasetBuilder;
|
use lance::dataset::builder::DatasetBuilder;
|
||||||
use lance::dataset::{InsertBuilder, WriteParams};
|
use lance::dataset::{InsertBuilder, WriteParams};
|
||||||
use lance::index::DatasetIndexExt;
|
use lance::index::DatasetIndexExt;
|
||||||
use lance::index::scalar::load_segment_params;
|
|
||||||
use lance::io::{ObjectStoreParams, WrappingObjectStore};
|
use lance::io::{ObjectStoreParams, WrappingObjectStore};
|
||||||
use lance_datafusion::utils::StreamingWriteSource;
|
use lance_datafusion::utils::StreamingWriteSource;
|
||||||
use lance_index::IndexCriteria;
|
use lance_index::IndexCriteria;
|
||||||
@@ -47,7 +46,6 @@ use std::sync::Arc;
|
|||||||
use crate::connection::NamespaceClientPushdownOperation;
|
use crate::connection::NamespaceClientPushdownOperation;
|
||||||
|
|
||||||
use crate::DistanceType;
|
use crate::DistanceType;
|
||||||
use crate::blob::BlobRangeRequest;
|
|
||||||
use crate::data::scannable::{PeekedScannable, Scannable, estimate_write_partitions};
|
use crate::data::scannable::{PeekedScannable, Scannable, estimate_write_partitions};
|
||||||
use crate::database::Database;
|
use crate::database::Database;
|
||||||
use crate::database::read_freshness::TableFreshness;
|
use crate::database::read_freshness::TableFreshness;
|
||||||
@@ -648,16 +646,6 @@ pub trait BaseTable: std::fmt::Display + std::fmt::Debug + Send + Sync {
|
|||||||
message: "fetch_blobs is not supported on this table type".into(),
|
message: "fetch_blobs is not supported on this table type".into(),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
/// Materialize blob-local ranges. See [`Table::fetch_blob_ranges`].
|
|
||||||
async fn fetch_blob_ranges(
|
|
||||||
&self,
|
|
||||||
_column: &str,
|
|
||||||
_requests: &[BlobRangeRequest],
|
|
||||||
) -> Result<LargeBinaryArray> {
|
|
||||||
Err(Error::NotSupported {
|
|
||||||
message: "fetch_blob_ranges is not supported on this table type".into(),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
/// Open lazy blob handles for the given row ids. See [`Table::fetch_blob_files`].
|
/// Open lazy blob handles for the given row ids. See [`Table::fetch_blob_files`].
|
||||||
async fn fetch_blob_files(
|
async fn fetch_blob_files(
|
||||||
&self,
|
&self,
|
||||||
@@ -1031,9 +1019,8 @@ impl Table {
|
|||||||
|
|
||||||
/// Materialize blob bytes for the given row ids.
|
/// Materialize blob bytes for the given row ids.
|
||||||
///
|
///
|
||||||
/// Output matches `row_ids` in length and order. Null blobs are null;
|
/// Output matches `row_ids` in length and order. Null and zero-length rows
|
||||||
/// valid empty blobs contain empty byte strings. Prefer
|
/// are null. Prefer [`Self::fetch_blob_files`] for large selections.
|
||||||
/// [`Self::fetch_blob_files`] for large selections.
|
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use arrow_array::UInt64Array;
|
/// use arrow_array::UInt64Array;
|
||||||
@@ -1068,47 +1055,6 @@ impl Table {
|
|||||||
self.inner.fetch_blobs(column.as_ref(), row_ids).await
|
self.inner.fetch_blobs(column.as_ref(), row_ids).await
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Materialize row-specific ranges from a blob v2 column.
|
|
||||||
///
|
|
||||||
/// Each request contains a row id and a blob-local offset and length.
|
|
||||||
/// Requests may be duplicated or reordered, including multiple
|
|
||||||
/// ranges for the same blob. The output has the same length and order as
|
|
||||||
/// the requests. Null blobs produce null output slots; empty ranges on
|
|
||||||
/// non-null blobs produce empty byte strings.
|
|
||||||
///
|
|
||||||
/// ```
|
|
||||||
/// use lancedb::blob::BlobRangeRequest;
|
|
||||||
///
|
|
||||||
/// # use lancedb::Table;
|
|
||||||
/// # async fn read_ranges(table: &Table, row_id: u64) -> Result<(), Box<dyn std::error::Error>> {
|
|
||||||
/// let ranges = table
|
|
||||||
/// .fetch_blob_ranges(
|
|
||||||
/// "image",
|
|
||||||
/// [
|
|
||||||
/// BlobRangeRequest::new(row_id, 0, 1024),
|
|
||||||
/// BlobRangeRequest::new(row_id, 4096, 1024),
|
|
||||||
/// ],
|
|
||||||
/// )
|
|
||||||
/// .await?;
|
|
||||||
/// # let _ = ranges;
|
|
||||||
/// # Ok(())
|
|
||||||
/// # }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Returns an error when a range is invalid, a requested row id does not
|
|
||||||
/// exist, or the column is not a blob v2 column. Returns
|
|
||||||
/// [`Error::NotSupported`] on table types without blob support.
|
|
||||||
pub async fn fetch_blob_ranges(
|
|
||||||
&self,
|
|
||||||
column: impl AsRef<str>,
|
|
||||||
requests: impl IntoIterator<Item = BlobRangeRequest>,
|
|
||||||
) -> Result<LargeBinaryArray> {
|
|
||||||
let requests = requests.into_iter().collect::<Vec<_>>();
|
|
||||||
self.inner
|
|
||||||
.fetch_blob_ranges(column.as_ref(), &requests)
|
|
||||||
.await
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Open lazy [`BlobFile`] handles for the given row ids.
|
/// Open lazy [`BlobFile`] handles for the given row ids.
|
||||||
///
|
///
|
||||||
/// Same length and order as `row_ids`. Null rows are `None`. Bytes are not
|
/// Same length and order as `row_ids`. Null rows are `None`. Bytes are not
|
||||||
@@ -3124,15 +3070,6 @@ impl BaseTable for NativeTable {
|
|||||||
crate::blob::take_blobs_aligned(&dataset, column, row_ids).await
|
crate::blob::take_blobs_aligned(&dataset, column, row_ids).await
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn fetch_blob_ranges(
|
|
||||||
&self,
|
|
||||||
column: &str,
|
|
||||||
requests: &[BlobRangeRequest],
|
|
||||||
) -> Result<LargeBinaryArray> {
|
|
||||||
let dataset = self.dataset.get().await?;
|
|
||||||
crate::blob::take_blob_ranges_aligned(&dataset, column, requests).await
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn fetch_blob_files(
|
async fn fetch_blob_files(
|
||||||
&self,
|
&self,
|
||||||
column: &str,
|
column: &str,
|
||||||
@@ -3194,9 +3131,10 @@ impl BaseTable for NativeTable {
|
|||||||
async fn list_indices(&self) -> Result<Vec<IndexConfig>> {
|
async fn list_indices(&self) -> Result<Vec<IndexConfig>> {
|
||||||
let dataset = self.dataset.get().await?;
|
let dataset = self.dataset.get().await?;
|
||||||
let total_rows = dataset.count_rows(None).await? as u64;
|
let total_rows = dataset.count_rows(None).await? as u64;
|
||||||
let descriptions = dataset.describe_indices(None).await?;
|
let indices = dataset
|
||||||
let mut indices: Vec<IndexConfig> = descriptions
|
.describe_indices(None)
|
||||||
.iter()
|
.await?
|
||||||
|
.into_iter()
|
||||||
.filter_map(|idx_desc| {
|
.filter_map(|idx_desc| {
|
||||||
let index_type: crate::index::IndexType = idx_desc
|
let index_type: crate::index::IndexType = idx_desc
|
||||||
.index_type()
|
.index_type()
|
||||||
@@ -3254,31 +3192,6 @@ impl BaseTable for NativeTable {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
for index in indices
|
|
||||||
.iter_mut()
|
|
||||||
.filter(|index| index.index_type == crate::index::IndexType::FTS)
|
|
||||||
{
|
|
||||||
let Some(description) = descriptions
|
|
||||||
.iter()
|
|
||||||
.find(|description| description.name() == index.name)
|
|
||||||
else {
|
|
||||||
continue;
|
|
||||||
};
|
|
||||||
let segments = description.segments();
|
|
||||||
let Some(segment) = segments.first() else {
|
|
||||||
continue;
|
|
||||||
};
|
|
||||||
let params = load_segment_params(&dataset, segment).await?;
|
|
||||||
let details = serde_json::to_string(¶ms).map_err(|source| Error::Other {
|
|
||||||
message: format!(
|
|
||||||
"Failed to serialize full text search configuration for index '{}'",
|
|
||||||
index.name
|
|
||||||
),
|
|
||||||
source: Some(Box::new(source)),
|
|
||||||
})?;
|
|
||||||
index.index_details = Some(details);
|
|
||||||
}
|
|
||||||
Ok(indices)
|
Ok(indices)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -4136,10 +4049,10 @@ mod tests {
|
|||||||
Box::new(RecordBatchIterator::new(vec![Ok(batch)], schema))
|
Box::new(RecordBatchIterator::new(vec![Ok(batch)], schema))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Windows does not support precise sleep durations due to timer resolution limitations.
|
||||||
|
#[cfg(not(target_os = "windows"))]
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_read_consistency_interval() {
|
async fn test_read_consistency_interval() {
|
||||||
use crate::utils::background_cache::clock;
|
|
||||||
|
|
||||||
let intervals = vec![
|
let intervals = vec![
|
||||||
None,
|
None,
|
||||||
Some(0),
|
Some(0),
|
||||||
@@ -4166,12 +4079,6 @@ mod tests {
|
|||||||
let conn2 = conn2.execute().await.unwrap();
|
let conn2 = conn2.execute().await.unwrap();
|
||||||
let table2 = conn2.open_table("my_table").execute().await.unwrap();
|
let table2 = conn2.open_table("my_table").execute().await.unwrap();
|
||||||
|
|
||||||
// Freeze the consistency clock now that `table2` has seeded its cache, so the
|
|
||||||
// interval only elapses when this test advances it. Otherwise the write and
|
|
||||||
// count_rows calls below race the real 100ms interval, which a loaded CI
|
|
||||||
// runner loses. Must come after open_table: creating the cache clears the mock.
|
|
||||||
clock::pin();
|
|
||||||
|
|
||||||
assert_eq!(table1.count_rows(None).await.unwrap(), 0);
|
assert_eq!(table1.count_rows(None).await.unwrap(), 0);
|
||||||
assert_eq!(table2.count_rows(None).await.unwrap(), 0);
|
assert_eq!(table2.count_rows(None).await.unwrap(), 0);
|
||||||
|
|
||||||
@@ -4189,7 +4096,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
Some(100) => {
|
Some(100) => {
|
||||||
assert_eq!(table2.count_rows(None).await.unwrap(), 0);
|
assert_eq!(table2.count_rows(None).await.unwrap(), 0);
|
||||||
clock::advance_by(Duration::from_millis(100));
|
tokio::time::sleep(Duration::from_millis(100)).await;
|
||||||
assert_eq!(table2.count_rows(None).await.unwrap(), 1);
|
assert_eq!(table2.count_rows(None).await.unwrap(), 1);
|
||||||
}
|
}
|
||||||
_ => unreachable!(),
|
_ => unreachable!(),
|
||||||
|
|||||||
@@ -382,9 +382,7 @@ mod tests {
|
|||||||
use crate::connect;
|
use crate::connect;
|
||||||
use crate::connection::ConnectBuilder;
|
use crate::connection::ConnectBuilder;
|
||||||
use crate::index::Index;
|
use crate::index::Index;
|
||||||
use crate::index::scalar::{
|
use crate::index::scalar::{BTreeIndexBuilder, BitmapIndexBuilder, FmIndexBuilder};
|
||||||
BTreeIndexBuilder, BitmapIndexBuilder, FmIndexBuilder, FtsIndexBuilder,
|
|
||||||
};
|
|
||||||
use crate::index::vector::{
|
use crate::index::vector::{
|
||||||
IvfHnswFlatIndexBuilder, IvfHnswPqIndexBuilder, IvfHnswSqIndexBuilder,
|
IvfHnswFlatIndexBuilder, IvfHnswPqIndexBuilder, IvfHnswSqIndexBuilder,
|
||||||
};
|
};
|
||||||
@@ -1364,57 +1362,16 @@ mod tests {
|
|||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
table
|
table
|
||||||
.create_index(
|
.create_index(&["text"], Index::FTS(Default::default()))
|
||||||
&["text"],
|
|
||||||
Index::FTS(
|
|
||||||
FtsIndexBuilder::default()
|
|
||||||
.stem(false)
|
|
||||||
.custom_stop_words(Some(vec!["cat".to_string()]))
|
|
||||||
.block_size(256)
|
|
||||||
.unwrap(),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
.execute()
|
.execute()
|
||||||
.await
|
.await
|
||||||
.unwrap();
|
.unwrap();
|
||||||
drop(table);
|
|
||||||
let table = conn.open_table("test_bitmap").execute().await.unwrap();
|
|
||||||
let index_configs = table.list_indices().await.unwrap();
|
let index_configs = table.list_indices().await.unwrap();
|
||||||
assert_eq!(index_configs.len(), 1);
|
assert_eq!(index_configs.len(), 1);
|
||||||
let index = index_configs.into_iter().next().unwrap();
|
let index = index_configs.into_iter().next().unwrap();
|
||||||
assert_eq!(index.index_type, crate::index::IndexType::FTS);
|
assert_eq!(index.index_type, crate::index::IndexType::FTS);
|
||||||
assert_eq!(index.columns, vec!["text".to_string()]);
|
assert_eq!(index.columns, vec!["text".to_string()]);
|
||||||
assert_eq!(index.name, "text_idx");
|
assert_eq!(index.name, "text_idx");
|
||||||
assert_eq!(index.index_version, Some(3));
|
|
||||||
let index_params: FtsIndexBuilder =
|
|
||||||
serde_json::from_str(index.index_details.as_deref().unwrap()).unwrap();
|
|
||||||
assert_eq!(index_params.posting_block_size(), 256);
|
|
||||||
assert_eq!(
|
|
||||||
serde_json::to_value(&index_params).unwrap()["custom_stop_words"],
|
|
||||||
serde_json::json!(["cat"])
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
table
|
|
||||||
.tokenize("cat dog", "text_idx")
|
|
||||||
.await
|
|
||||||
.unwrap()
|
|
||||||
.into_iter()
|
|
||||||
.map(|token| token.text)
|
|
||||||
.collect::<Vec<_>>(),
|
|
||||||
vec!["dog"]
|
|
||||||
);
|
|
||||||
|
|
||||||
let batches = table
|
|
||||||
.query()
|
|
||||||
.full_text_search(FullTextSearchQuery::new("cat dog".to_string()))
|
|
||||||
.limit(120)
|
|
||||||
.execute()
|
|
||||||
.await
|
|
||||||
.unwrap()
|
|
||||||
.try_collect::<Vec<_>>()
|
|
||||||
.await
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(batches.iter().map(RecordBatch::num_rows).sum::<usize>(), 40);
|
|
||||||
|
|
||||||
let num_rows = 120;
|
let num_rows = 120;
|
||||||
let stats = table.index_stats("text_idx").await.unwrap().unwrap();
|
let stats = table.index_stats("text_idx").await.unwrap().unwrap();
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user