Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add spark-lance-connector readme #2456

Merged
merged 3 commits into from
Jun 11, 2024
Merged

Conversation

LuQQiu
Copy link
Collaborator

@LuQQiu LuQQiu commented Jun 9, 2024

Add spark-lance-connector example and quick start.
Add connector jars link to enable tryout

@LuQQiu LuQQiu requested review from QianZhu and eddyxu June 9, 2024 05:16
@github-actions github-actions bot added the java label Jun 9, 2024
Copy link

github-actions bot commented Jun 9, 2024

ACTION NEEDED
Lance follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

For details on the error please inspect the "PR Title Check" action.

@LuQQiu LuQQiu changed the title doc: add spark-lance-connector readme docs: add spark-lance-connector readme Jun 9, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 9, 2024
@LuQQiu
Copy link
Collaborator Author

LuQQiu commented Jun 10, 2024

@QianZhu Would it be better for me to move the doc to https://github.com/lancedb/lance/tree/main/docs/integrations ?

@@ -0,0 +1,79 @@
# Spark-Lance Connector
Copy link
Contributor

Choose a reason for hiding this comment

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

@eddyxu , do we have plans to add this documentation to our doc website later?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, we should do that

@eddyxu eddyxu merged commit cf4f28a into lancedb:main Jun 11, 2024
4 checks passed
renovate bot referenced this pull request in spiraldb/vortex Jun 13, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [lance](https://togithub.com/lancedb/lance) | dependencies | patch |
`0.12.1` -> `0.12.2` |

---

### Release Notes

<details>
<summary>lancedb/lance (lance)</summary>

### [`v0.12.2`](https://togithub.com/lancedb/lance/releases/tag/v0.12.2)

[Compare
Source](https://togithub.com/lancedb/lance/compare/v0.12.1...v0.12.2)

<!-- Release notes generated using configuration in .github/release.yml
at v0.12.2 -->

#### What's Changed

##### New Features 🎉

- feat: support IVF_FLAT index by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2418](https://togithub.com/lancedb/lance/pull/2418)
- feat: add support for arbitrary global buffers to the v2 reader/writer
by [@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2445](https://togithub.com/lancedb/lance/pull/2445)
- feat: add pushdown to the read path by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2444](https://togithub.com/lancedb/lance/pull/2444)
- feat: scan with stable row id by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2441](https://togithub.com/lancedb/lance/pull/2441)
- feat(java): add lance spark connector for read by
[@&#8203;LuQQiu](https://togithub.com/LuQQiu) in
[https://github.com/lancedb/lance/pull/2429](https://togithub.com/lancedb/lance/pull/2429)
- feat: pickle the manifest when pickling a dataset by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2459](https://togithub.com/lancedb/lance/pull/2459)
- feat: store IVF in global buffer by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2449](https://togithub.com/lancedb/lance/pull/2449)

##### Bug Fixes 🐛

- fix: lance.torch.LanceDataset spelt readahead wrong by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2453](https://togithub.com/lancedb/lance/pull/2453)
- fix: respect storage options on `create_index` by
[@&#8203;joshua-auchincloss](https://togithub.com/joshua-auchincloss) in
[https://github.com/lancedb/lance/pull/2460](https://togithub.com/lancedb/lance/pull/2460)
- fix: incorrect logic when decoding manifest from last block by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2464](https://togithub.com/lancedb/lance/pull/2464)

##### Documentation 📚

- docs: add spark-lance-connector readme by
[@&#8203;LuQQiu](https://togithub.com/LuQQiu) in
[https://github.com/lancedb/lance/pull/2456](https://togithub.com/lancedb/lance/pull/2456)

##### Performance Improvements 🚀

- perf: speed up hnsw build by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2448](https://togithub.com/lancedb/lance/pull/2448)
- perf: better L2 code generation by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2450](https://togithub.com/lancedb/lance/pull/2450)

##### Other Changes

- refactor: pull row_id and deletion vector out of v1 file reader by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2436](https://togithub.com/lancedb/lance/pull/2436)
- refactor: move Prefilter to a trait and move VectorIndex to
lance-vector by [@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2442](https://togithub.com/lancedb/lance/pull/2442)
- refactor: move hnsw from lance crate to lance-index crate by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2446](https://togithub.com/lancedb/lance/pull/2446)
- refactor: impl the sub index trait for HNSW and clean code by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2462](https://togithub.com/lancedb/lance/pull/2462)

#### New Contributors

- [@&#8203;joshua-auchincloss](https://togithub.com/joshua-auchincloss)
made their first contribution in
[https://github.com/lancedb/lance/pull/2460](https://togithub.com/lancedb/lance/pull/2460)

**Full Changelog**:
lancedb/lance@v0.12.1...v0.12.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/spiraldb/vortex).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjM5My4wIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
AdamGS referenced this pull request in AdamGS/vortex Jun 14, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [lance](https://togithub.com/lancedb/lance) | dependencies | patch |
`0.12.1` -> `0.12.2` |

---

### Release Notes

<details>
<summary>lancedb/lance (lance)</summary>

### [`v0.12.2`](https://togithub.com/lancedb/lance/releases/tag/v0.12.2)

[Compare
Source](https://togithub.com/lancedb/lance/compare/v0.12.1...v0.12.2)

<!-- Release notes generated using configuration in .github/release.yml
at v0.12.2 -->

#### What's Changed

##### New Features 🎉

- feat: support IVF_FLAT index by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2418](https://togithub.com/lancedb/lance/pull/2418)
- feat: add support for arbitrary global buffers to the v2 reader/writer
by [@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2445](https://togithub.com/lancedb/lance/pull/2445)
- feat: add pushdown to the read path by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2444](https://togithub.com/lancedb/lance/pull/2444)
- feat: scan with stable row id by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2441](https://togithub.com/lancedb/lance/pull/2441)
- feat(java): add lance spark connector for read by
[@&#8203;LuQQiu](https://togithub.com/LuQQiu) in
[https://github.com/lancedb/lance/pull/2429](https://togithub.com/lancedb/lance/pull/2429)
- feat: pickle the manifest when pickling a dataset by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2459](https://togithub.com/lancedb/lance/pull/2459)
- feat: store IVF in global buffer by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2449](https://togithub.com/lancedb/lance/pull/2449)

##### Bug Fixes 🐛

- fix: lance.torch.LanceDataset spelt readahead wrong by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2453](https://togithub.com/lancedb/lance/pull/2453)
- fix: respect storage options on `create_index` by
[@&#8203;joshua-auchincloss](https://togithub.com/joshua-auchincloss) in
[https://github.com/lancedb/lance/pull/2460](https://togithub.com/lancedb/lance/pull/2460)
- fix: incorrect logic when decoding manifest from last block by
[@&#8203;westonpace](https://togithub.com/westonpace) in
[https://github.com/lancedb/lance/pull/2464](https://togithub.com/lancedb/lance/pull/2464)

##### Documentation 📚

- docs: add spark-lance-connector readme by
[@&#8203;LuQQiu](https://togithub.com/LuQQiu) in
[https://github.com/lancedb/lance/pull/2456](https://togithub.com/lancedb/lance/pull/2456)

##### Performance Improvements 🚀

- perf: speed up hnsw build by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2448](https://togithub.com/lancedb/lance/pull/2448)
- perf: better L2 code generation by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2450](https://togithub.com/lancedb/lance/pull/2450)

##### Other Changes

- refactor: pull row_id and deletion vector out of v1 file reader by
[@&#8203;wjones127](https://togithub.com/wjones127) in
[https://github.com/lancedb/lance/pull/2436](https://togithub.com/lancedb/lance/pull/2436)
- refactor: move Prefilter to a trait and move VectorIndex to
lance-vector by [@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2442](https://togithub.com/lancedb/lance/pull/2442)
- refactor: move hnsw from lance crate to lance-index crate by
[@&#8203;eddyxu](https://togithub.com/eddyxu) in
[https://github.com/lancedb/lance/pull/2446](https://togithub.com/lancedb/lance/pull/2446)
- refactor: impl the sub index trait for HNSW and clean code by
[@&#8203;BubbleCal](https://togithub.com/BubbleCal) in
[https://github.com/lancedb/lance/pull/2462](https://togithub.com/lancedb/lance/pull/2462)

#### New Contributors

- [@&#8203;joshua-auchincloss](https://togithub.com/joshua-auchincloss)
made their first contribution in
[https://github.com/lancedb/lance/pull/2460](https://togithub.com/lancedb/lance/pull/2460)

**Full Changelog**:
lancedb/lance@v0.12.1...v0.12.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/spiraldb/vortex).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjM5My4wIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation java
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants