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: schema evolution #1911

Merged
merged 4 commits into from
Jul 30, 2024
Merged

Conversation

wjones127
Copy link
Contributor

@wjones127 wjones127 commented Feb 4, 2024

  • Adds a documentation section for schema evolution methods, describing each.
  • Consolidates methods for schema evolution in Rust, so they have their own header.

@wjones127
Copy link
Contributor Author

Make sure to answer these questions: #1909 (comment)

@github-actions github-actions bot added documentation Improvements or additions to documentation python labels Jul 30, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jul 30, 2024

Codecov Report

Attention: Patch coverage is 68.35443% with 25 lines in your changes missing coverage. Please review.

Project coverage is 79.42%. Comparing base (8c2667d) to head (ca54d67).

Files Patch % Lines
rust/lance/src/dataset.rs 68.35% 21 Missing and 4 partials ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1911   +/-   ##
=======================================
  Coverage   79.41%   79.42%           
=======================================
  Files         223      223           
  Lines       65082    65082           
  Branches    65082    65082           
=======================================
+ Hits        51686    51689    +3     
- Misses      10396    10405    +9     
+ Partials     3000     2988   -12     
Flag Coverage Δ
unittests 79.42% <68.35%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wjones127 wjones127 marked this pull request as ready for review July 30, 2024 18:26
docs/read_and_write.rst Outdated Show resolved Hide resolved
docs/read_and_write.rst Outdated Show resolved Hide resolved
table = pa.table({"id": pa.array([1, 2, 3])})
dataset = lance.write_dataset(table, "ids")

@lance.batch_udf(checkpoint_file="embedding_checkpoint.sqlite")
Copy link
Contributor

Choose a reason for hiding this comment

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

sqlite might an interesting choice of extension to an outside observer. If we want these files to be opaque maybe just .bin?

docs/read_and_write.rst Outdated Show resolved Hide resolved
docs/read_and_write.rst Outdated Show resolved Hide resolved
rust/lance/src/dataset.rs Outdated Show resolved Hide resolved
Comment on lines +1250 to +1258
/// Drop columns from the dataset and return updated dataset. Note that this
/// is a zero-copy operation and column is not physically removed from the
/// dataset.
/// Parameters:
/// - `columns`: the list of column names to drop.
#[deprecated(since = "0.9.12", note = "Please use `drop_columns` instead.")]
pub async fn drop(&mut self, columns: &[&str]) -> Result<()> {
self.drop_columns(columns).await
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This has been deprecated a while, can we just remove it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can do that in a follow up. Will better show up in change notes if I do a dedicated PR.

Co-authored-by: Weston Pace <weston.pace@gmail.com>
@wjones127 wjones127 merged commit 588c416 into lancedb:main Jul 30, 2024
23 checks passed
@wjones127 wjones127 deleted the schema-evolution-docs branch July 30, 2024 22:06
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 python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants