1use core::panic;
5use std::collections::HashMap;
6use std::sync::atomic::AtomicBool;
7use std::sync::Arc;
8
9use arrow_array::RecordBatch;
10
11use arrow_data::ArrayData;
12use bytes::{BufMut, Bytes, BytesMut};
13use futures::stream::FuturesOrdered;
14use futures::StreamExt;
15use lance_core::datatypes::{Field, Schema as LanceSchema};
16use lance_core::utils::bit::pad_bytes;
17use lance_core::{Error, Result};
18use lance_encoding::decoder::PageEncoding;
19use lance_encoding::encoder::{
20 default_encoding_strategy, BatchEncoder, EncodeTask, EncodedBatch, EncodedPage,
21 EncodingOptions, FieldEncoder, FieldEncodingStrategy, OutOfLineBuffers,
22};
23use lance_encoding::repdef::RepDefBuilder;
24use lance_encoding::version::LanceFileVersion;
25use lance_io::object_store::ObjectStore;
26use lance_io::object_writer::ObjectWriter;
27use lance_io::traits::Writer;
28use log::{debug, warn};
29use object_store::path::Path;
30use prost::Message;
31use prost_types::Any;
32use snafu::location;
33use tokio::io::AsyncWriteExt;
34use tracing::instrument;
35
36use crate::datatypes::FieldsWithMeta;
37use crate::format::pb;
38use crate::format::pbfile;
39use crate::format::pbfile::DirectEncoding;
40use crate::format::MAGIC;
41
42pub(crate) const PAGE_BUFFER_ALIGNMENT: usize = 64;
44const PAD_BUFFER: [u8; PAGE_BUFFER_ALIGNMENT] = [72; PAGE_BUFFER_ALIGNMENT];
45const MAX_PAGE_BYTES: usize = 32 * 1024 * 1024;
51const ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES: &str = "LANCE_FILE_WRITER_MAX_PAGE_BYTES";
52
53#[derive(Debug, Clone, Default)]
54pub struct FileWriterOptions {
55 pub data_cache_bytes: Option<u64>,
70 pub max_page_bytes: Option<u64>,
76 pub keep_original_array: Option<bool>,
94 pub encoding_strategy: Option<Arc<dyn FieldEncodingStrategy>>,
95 pub format_version: Option<LanceFileVersion>,
101}
102
103pub struct FileWriter {
104 writer: ObjectWriter,
105 schema: Option<LanceSchema>,
106 column_writers: Vec<Box<dyn FieldEncoder>>,
107 column_metadata: Vec<pbfile::ColumnMetadata>,
108 field_id_to_column_indices: Vec<(u32, u32)>,
109 num_columns: u32,
110 rows_written: u64,
111 global_buffers: Vec<(u64, u64)>,
112 schema_metadata: HashMap<String, String>,
113 options: FileWriterOptions,
114}
115
116fn initial_column_metadata() -> pbfile::ColumnMetadata {
117 pbfile::ColumnMetadata {
118 pages: Vec::new(),
119 buffer_offsets: Vec::new(),
120 buffer_sizes: Vec::new(),
121 encoding: None,
122 }
123}
124
125static WARNED_ON_UNSTABLE_API: AtomicBool = AtomicBool::new(false);
126
127impl FileWriter {
128 pub fn try_new(
130 object_writer: ObjectWriter,
131 schema: LanceSchema,
132 options: FileWriterOptions,
133 ) -> Result<Self> {
134 let mut writer = Self::new_lazy(object_writer, options);
135 writer.initialize(schema)?;
136 Ok(writer)
137 }
138
139 pub fn new_lazy(object_writer: ObjectWriter, options: FileWriterOptions) -> Self {
144 if let Some(format_version) = options.format_version {
145 if format_version.is_unstable()
146 && WARNED_ON_UNSTABLE_API
147 .compare_exchange(
148 false,
149 true,
150 std::sync::atomic::Ordering::Relaxed,
151 std::sync::atomic::Ordering::Relaxed,
152 )
153 .is_ok()
154 {
155 warn!("You have requested an unstable format version. Files written with this format version may not be readable in the future! This is a development feature and should only be used for experimentation and never for production data.");
156 }
157 }
158 Self {
159 writer: object_writer,
160 schema: None,
161 column_writers: Vec::new(),
162 column_metadata: Vec::new(),
163 num_columns: 0,
164 rows_written: 0,
165 field_id_to_column_indices: Vec::new(),
166 global_buffers: Vec::new(),
167 schema_metadata: HashMap::new(),
168 options,
169 }
170 }
171
172 pub async fn create_file_with_batches(
176 store: &ObjectStore,
177 path: &Path,
178 schema: lance_core::datatypes::Schema,
179 batches: impl Iterator<Item = RecordBatch> + Send,
180 options: FileWriterOptions,
181 ) -> Result<usize> {
182 let writer = store.create(path).await?;
183 let mut writer = Self::try_new(writer, schema, options)?;
184 for batch in batches {
185 writer.write_batch(&batch).await?;
186 }
187 Ok(writer.finish().await? as usize)
188 }
189
190 async fn do_write_buffer(writer: &mut ObjectWriter, buf: &[u8]) -> Result<()> {
191 writer.write_all(buf).await?;
192 let pad_bytes = pad_bytes::<PAGE_BUFFER_ALIGNMENT>(buf.len());
193 writer.write_all(&PAD_BUFFER[..pad_bytes]).await?;
194 Ok(())
195 }
196
197 pub fn version(&self) -> LanceFileVersion {
199 self.options.format_version.unwrap_or_default()
200 }
201
202 async fn write_page(&mut self, encoded_page: EncodedPage) -> Result<()> {
203 let buffers = encoded_page.data;
204 let mut buffer_offsets = Vec::with_capacity(buffers.len());
205 let mut buffer_sizes = Vec::with_capacity(buffers.len());
206 for buffer in buffers {
207 buffer_offsets.push(self.writer.tell().await? as u64);
208 buffer_sizes.push(buffer.len() as u64);
209 Self::do_write_buffer(&mut self.writer, &buffer).await?;
210 }
211 let encoded_encoding = match encoded_page.description {
212 PageEncoding::Legacy(array_encoding) => Any::from_msg(&array_encoding)?.encode_to_vec(),
213 PageEncoding::Structural(page_layout) => Any::from_msg(&page_layout)?.encode_to_vec(),
214 };
215 let page = pbfile::column_metadata::Page {
216 buffer_offsets,
217 buffer_sizes,
218 encoding: Some(pbfile::Encoding {
219 location: Some(pbfile::encoding::Location::Direct(DirectEncoding {
220 encoding: encoded_encoding,
221 })),
222 }),
223 length: encoded_page.num_rows,
224 priority: encoded_page.row_number,
225 };
226 self.column_metadata[encoded_page.column_idx as usize]
227 .pages
228 .push(page);
229 Ok(())
230 }
231
232 #[instrument(skip_all, level = "debug")]
233 async fn write_pages(&mut self, mut encoding_tasks: FuturesOrdered<EncodeTask>) -> Result<()> {
234 while let Some(encoding_task) = encoding_tasks.next().await {
243 let encoded_page = encoding_task?;
244 self.write_page(encoded_page).await?;
245 }
246 self.writer.flush().await?;
251 Ok(())
252 }
253
254 pub async fn write_batches(
256 &mut self,
257 batches: impl Iterator<Item = &RecordBatch>,
258 ) -> Result<()> {
259 for batch in batches {
260 self.write_batch(batch).await?;
261 }
262 Ok(())
263 }
264
265 fn verify_field_nullability(arr: &ArrayData, field: &Field) -> Result<()> {
266 if !field.nullable && arr.null_count() > 0 {
267 return Err(Error::invalid_input(format!("The field `{}` contained null values even though the field is marked non-null in the schema", field.name), location!()));
268 }
269
270 for (child_field, child_arr) in field.children.iter().zip(arr.child_data()) {
271 Self::verify_field_nullability(child_arr, child_field)?;
272 }
273
274 Ok(())
275 }
276
277 fn verify_nullability_constraints(&self, batch: &RecordBatch) -> Result<()> {
278 for (col, field) in batch
279 .columns()
280 .iter()
281 .zip(self.schema.as_ref().unwrap().fields.iter())
282 {
283 Self::verify_field_nullability(&col.to_data(), field)?;
284 }
285 Ok(())
286 }
287
288 fn initialize(&mut self, mut schema: LanceSchema) -> Result<()> {
289 let cache_bytes_per_column = if let Some(data_cache_bytes) = self.options.data_cache_bytes {
290 data_cache_bytes / schema.fields.len() as u64
291 } else {
292 8 * 1024 * 1024
293 };
294
295 let max_page_bytes = self.options.max_page_bytes.unwrap_or_else(|| {
296 std::env::var(ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES)
297 .map(|s| {
298 s.parse::<u64>().unwrap_or_else(|e| {
299 warn!(
300 "Failed to parse {}: {}, using default",
301 ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES, e
302 );
303 MAX_PAGE_BYTES as u64
304 })
305 })
306 .unwrap_or(MAX_PAGE_BYTES as u64)
307 });
308
309 schema.validate()?;
310
311 let keep_original_array = self.options.keep_original_array.unwrap_or(false);
312 let encoding_strategy = self.options.encoding_strategy.clone().unwrap_or_else(|| {
313 let version = self.version();
314 default_encoding_strategy(version).into()
315 });
316
317 let encoding_options = EncodingOptions {
318 cache_bytes_per_column,
319 max_page_bytes,
320 keep_original_array,
321 buffer_alignment: PAGE_BUFFER_ALIGNMENT as u64,
322 version: self.version(),
323 };
324 let encoder =
325 BatchEncoder::try_new(&schema, encoding_strategy.as_ref(), &encoding_options)?;
326 self.num_columns = encoder.num_columns();
327
328 self.column_writers = encoder.field_encoders;
329 self.column_metadata = vec![initial_column_metadata(); self.num_columns as usize];
330 self.field_id_to_column_indices = encoder.field_id_to_column_index;
331 self.schema_metadata
332 .extend(std::mem::take(&mut schema.metadata));
333 self.schema = Some(schema);
334 Ok(())
335 }
336
337 fn ensure_initialized(&mut self, batch: &RecordBatch) -> Result<&LanceSchema> {
338 if self.schema.is_none() {
339 let schema = LanceSchema::try_from(batch.schema().as_ref())?;
340 self.initialize(schema)?;
341 }
342 Ok(self.schema.as_ref().unwrap())
343 }
344
345 #[instrument(skip_all, level = "debug")]
346 fn encode_batch(
347 &mut self,
348 batch: &RecordBatch,
349 external_buffers: &mut OutOfLineBuffers,
350 ) -> Result<Vec<Vec<EncodeTask>>> {
351 self.schema
352 .as_ref()
353 .unwrap()
354 .fields
355 .iter()
356 .zip(self.column_writers.iter_mut())
357 .map(|(field, column_writer)| {
358 let array = batch
359 .column_by_name(&field.name)
360 .ok_or(Error::InvalidInput {
361 source: format!(
362 "Cannot write batch. The batch was missing the column `{}`",
363 field.name
364 )
365 .into(),
366 location: location!(),
367 })?;
368 let repdef = RepDefBuilder::default();
369 let num_rows = array.len() as u64;
370 column_writer.maybe_encode(
371 array.clone(),
372 external_buffers,
373 repdef,
374 self.rows_written,
375 num_rows,
376 )
377 })
378 .collect::<Result<Vec<_>>>()
379 }
380
381 pub async fn write_batch(&mut self, batch: &RecordBatch) -> Result<()> {
386 debug!(
387 "write_batch called with {} rows, {} columns, and {} bytes of data",
388 batch.num_rows(),
389 batch.num_columns(),
390 batch.get_array_memory_size()
391 );
392 self.ensure_initialized(batch)?;
393 self.verify_nullability_constraints(batch)?;
394 let num_rows = batch.num_rows() as u64;
395 if num_rows == 0 {
396 return Ok(());
397 }
398 if num_rows > u32::MAX as u64 {
399 return Err(Error::InvalidInput {
400 source: "cannot write Lance files with more than 2^32 rows".into(),
401 location: location!(),
402 });
403 }
404 let mut external_buffers =
407 OutOfLineBuffers::new(self.tell().await?, PAGE_BUFFER_ALIGNMENT as u64);
408 let encoding_tasks = self.encode_batch(batch, &mut external_buffers)?;
409 for external_buffer in external_buffers.take_buffers() {
411 Self::do_write_buffer(&mut self.writer, &external_buffer).await?;
412 }
413
414 let encoding_tasks = encoding_tasks
415 .into_iter()
416 .flatten()
417 .collect::<FuturesOrdered<_>>();
418
419 self.rows_written = match self.rows_written.checked_add(batch.num_rows() as u64) {
420 Some(rows_written) => rows_written,
421 None => {
422 return Err(Error::InvalidInput { source: format!("cannot write batch with {} rows because {} rows have already been written and Lance files cannot contain more than 2^64 rows", num_rows, self.rows_written).into(), location: location!() });
423 }
424 };
425
426 self.write_pages(encoding_tasks).await?;
427
428 Ok(())
429 }
430
431 async fn write_column_metadata(
432 &mut self,
433 metadata: pbfile::ColumnMetadata,
434 ) -> Result<(u64, u64)> {
435 let metadata_bytes = metadata.encode_to_vec();
436 let position = self.writer.tell().await? as u64;
437 let len = metadata_bytes.len() as u64;
438 self.writer.write_all(&metadata_bytes).await?;
439 Ok((position, len))
440 }
441
442 async fn write_column_metadatas(&mut self) -> Result<Vec<(u64, u64)>> {
443 let mut metadatas = Vec::new();
444 std::mem::swap(&mut self.column_metadata, &mut metadatas);
445 let mut metadata_positions = Vec::with_capacity(metadatas.len());
446 for metadata in metadatas {
447 metadata_positions.push(self.write_column_metadata(metadata).await?);
448 }
449 Ok(metadata_positions)
450 }
451
452 fn make_file_descriptor(
453 schema: &lance_core::datatypes::Schema,
454 num_rows: u64,
455 ) -> Result<pb::FileDescriptor> {
456 let fields_with_meta = FieldsWithMeta::from(schema);
457 Ok(pb::FileDescriptor {
458 schema: Some(pb::Schema {
459 fields: fields_with_meta.fields.0,
460 metadata: fields_with_meta.metadata,
461 }),
462 length: num_rows,
463 })
464 }
465
466 async fn write_global_buffers(&mut self) -> Result<Vec<(u64, u64)>> {
467 let schema = self.schema.as_mut().ok_or(Error::invalid_input("No schema provided on writer open and no data provided. Schema is unknown and file cannot be created", location!()))?;
468 schema.metadata = std::mem::take(&mut self.schema_metadata);
469 schema.fields.iter_mut().for_each(|f| {
473 if f.is_blob_v2() {
474 f.unloaded_mut();
475 }
476 });
477
478 let file_descriptor = Self::make_file_descriptor(schema, self.rows_written)?;
479 let file_descriptor_bytes = file_descriptor.encode_to_vec();
480 let file_descriptor_len = file_descriptor_bytes.len() as u64;
481 let file_descriptor_position = self.writer.tell().await? as u64;
482 self.writer.write_all(&file_descriptor_bytes).await?;
483 let mut gbo_table = Vec::with_capacity(1 + self.global_buffers.len());
484 gbo_table.push((file_descriptor_position, file_descriptor_len));
485 gbo_table.append(&mut self.global_buffers);
486 Ok(gbo_table)
487 }
488
489 pub fn add_schema_metadata(&mut self, key: impl Into<String>, value: impl Into<String>) {
495 self.schema_metadata.insert(key.into(), value.into());
496 }
497
498 pub async fn add_global_buffer(&mut self, buffer: Bytes) -> Result<u32> {
504 let position = self.writer.tell().await? as u64;
505 let len = buffer.len() as u64;
506 Self::do_write_buffer(&mut self.writer, &buffer).await?;
507 self.global_buffers.push((position, len));
508 Ok(self.global_buffers.len() as u32)
509 }
510
511 async fn finish_writers(&mut self) -> Result<()> {
512 let mut col_idx = 0;
513 for mut writer in std::mem::take(&mut self.column_writers) {
514 let mut external_buffers =
515 OutOfLineBuffers::new(self.tell().await?, PAGE_BUFFER_ALIGNMENT as u64);
516 let columns = writer.finish(&mut external_buffers).await?;
517 for buffer in external_buffers.take_buffers() {
518 self.writer.write_all(&buffer).await?;
519 }
520 debug_assert_eq!(
521 columns.len(),
522 writer.num_columns() as usize,
523 "Expected {} columns from column at index {} and got {}",
524 writer.num_columns(),
525 col_idx,
526 columns.len()
527 );
528 for column in columns {
529 for page in column.final_pages {
530 self.write_page(page).await?;
531 }
532 let column_metadata = &mut self.column_metadata[col_idx];
533 let mut buffer_pos = self.writer.tell().await? as u64;
534 for buffer in column.column_buffers {
535 column_metadata.buffer_offsets.push(buffer_pos);
536 let mut size = 0;
537 Self::do_write_buffer(&mut self.writer, &buffer).await?;
538 size += buffer.len() as u64;
539 buffer_pos += size;
540 column_metadata.buffer_sizes.push(size);
541 }
542 let encoded_encoding = Any::from_msg(&column.encoding)?.encode_to_vec();
543 column_metadata.encoding = Some(pbfile::Encoding {
544 location: Some(pbfile::encoding::Location::Direct(pbfile::DirectEncoding {
545 encoding: encoded_encoding,
546 })),
547 });
548 col_idx += 1;
549 }
550 }
551 if col_idx != self.column_metadata.len() {
552 panic!(
553 "Column writers finished with {} columns but we expected {}",
554 col_idx,
555 self.column_metadata.len()
556 );
557 }
558 Ok(())
559 }
560
561 fn version_to_numbers(&self) -> (u16, u16) {
564 let version = self.options.format_version.unwrap_or_default();
565 match version.resolve() {
566 LanceFileVersion::V2_0 => (0, 3),
567 LanceFileVersion::V2_1 => (2, 1),
568 LanceFileVersion::V2_2 => (2, 2),
569 _ => panic!("Unsupported version: {}", version),
570 }
571 }
572
573 pub async fn finish(&mut self) -> Result<u64> {
581 let mut external_buffers =
583 OutOfLineBuffers::new(self.tell().await?, PAGE_BUFFER_ALIGNMENT as u64);
584 let encoding_tasks = self
585 .column_writers
586 .iter_mut()
587 .map(|writer| writer.flush(&mut external_buffers))
588 .collect::<Result<Vec<_>>>()?;
589 for external_buffer in external_buffers.take_buffers() {
590 Self::do_write_buffer(&mut self.writer, &external_buffer).await?;
591 }
592 let encoding_tasks = encoding_tasks
593 .into_iter()
594 .flatten()
595 .collect::<FuturesOrdered<_>>();
596 self.write_pages(encoding_tasks).await?;
597
598 self.finish_writers().await?;
599
600 let global_buffer_offsets = self.write_global_buffers().await?;
602 let num_global_buffers = global_buffer_offsets.len() as u32;
603
604 let column_metadata_start = self.writer.tell().await? as u64;
606 let metadata_positions = self.write_column_metadatas().await?;
607
608 let cmo_table_start = self.writer.tell().await? as u64;
610 for (meta_pos, meta_len) in metadata_positions {
611 self.writer.write_u64_le(meta_pos).await?;
612 self.writer.write_u64_le(meta_len).await?;
613 }
614
615 let gbo_table_start = self.writer.tell().await? as u64;
617 for (gbo_pos, gbo_len) in global_buffer_offsets {
618 self.writer.write_u64_le(gbo_pos).await?;
619 self.writer.write_u64_le(gbo_len).await?;
620 }
621
622 let (major, minor) = self.version_to_numbers();
623 self.writer.write_u64_le(column_metadata_start).await?;
625 self.writer.write_u64_le(cmo_table_start).await?;
626 self.writer.write_u64_le(gbo_table_start).await?;
627 self.writer.write_u32_le(num_global_buffers).await?;
628 self.writer.write_u32_le(self.num_columns).await?;
629 self.writer.write_u16_le(major).await?;
630 self.writer.write_u16_le(minor).await?;
631 self.writer.write_all(MAGIC).await?;
632
633 self.writer.shutdown().await?;
635 Ok(self.rows_written)
636 }
637
638 pub async fn abort(&mut self) {
639 self.writer.abort().await;
640 }
641
642 pub async fn tell(&mut self) -> Result<u64> {
643 Ok(self.writer.tell().await? as u64)
644 }
645
646 pub fn field_id_to_column_indices(&self) -> &[(u32, u32)] {
647 &self.field_id_to_column_indices
648 }
649}
650
651pub trait EncodedBatchWriteExt {
654 fn try_to_self_described_lance(&self, version: LanceFileVersion) -> Result<Bytes>;
656 fn try_to_mini_lance(&self, version: LanceFileVersion) -> Result<Bytes>;
660}
661
662fn concat_lance_footer(
667 batch: &EncodedBatch,
668 write_schema: bool,
669 version: LanceFileVersion,
670) -> Result<Bytes> {
671 let mut data = BytesMut::with_capacity(batch.data.len() + 1024 * 1024);
673 data.put(batch.data.clone());
674 let global_buffers = if write_schema {
676 let schema_start = data.len() as u64;
677 let lance_schema = lance_core::datatypes::Schema::try_from(batch.schema.as_ref())?;
678 let descriptor = FileWriter::make_file_descriptor(&lance_schema, batch.num_rows)?;
679 let descriptor_bytes = descriptor.encode_to_vec();
680 let descriptor_len = descriptor_bytes.len() as u64;
681 data.put(descriptor_bytes.as_slice());
682
683 vec![(schema_start, descriptor_len)]
684 } else {
685 vec![]
686 };
687 let col_metadata_start = data.len() as u64;
688
689 let mut col_metadata_positions = Vec::new();
690 for col in &batch.page_table {
692 let position = data.len() as u64;
693 let pages = col
694 .page_infos
695 .iter()
696 .map(|page_info| {
697 let encoded_encoding = match &page_info.encoding {
698 PageEncoding::Legacy(array_encoding) => {
699 Any::from_msg(array_encoding)?.encode_to_vec()
700 }
701 PageEncoding::Structural(page_layout) => {
702 Any::from_msg(page_layout)?.encode_to_vec()
703 }
704 };
705 let (buffer_offsets, buffer_sizes): (Vec<_>, Vec<_>) = page_info
706 .buffer_offsets_and_sizes
707 .as_ref()
708 .iter()
709 .cloned()
710 .unzip();
711 Ok(pbfile::column_metadata::Page {
712 buffer_offsets,
713 buffer_sizes,
714 encoding: Some(pbfile::Encoding {
715 location: Some(pbfile::encoding::Location::Direct(DirectEncoding {
716 encoding: encoded_encoding,
717 })),
718 }),
719 length: page_info.num_rows,
720 priority: page_info.priority,
721 })
722 })
723 .collect::<Result<Vec<_>>>()?;
724 let (buffer_offsets, buffer_sizes): (Vec<_>, Vec<_>) =
725 col.buffer_offsets_and_sizes.iter().cloned().unzip();
726 let encoded_col_encoding = Any::from_msg(&col.encoding)?.encode_to_vec();
727 let column = pbfile::ColumnMetadata {
728 pages,
729 buffer_offsets,
730 buffer_sizes,
731 encoding: Some(pbfile::Encoding {
732 location: Some(pbfile::encoding::Location::Direct(pbfile::DirectEncoding {
733 encoding: encoded_col_encoding,
734 })),
735 }),
736 };
737 let column_bytes = column.encode_to_vec();
738 col_metadata_positions.push((position, column_bytes.len() as u64));
739 data.put(column_bytes.as_slice());
740 }
741 let cmo_table_start = data.len() as u64;
743 for (meta_pos, meta_len) in col_metadata_positions {
744 data.put_u64_le(meta_pos);
745 data.put_u64_le(meta_len);
746 }
747 let gbo_table_start = data.len() as u64;
749 let num_global_buffers = global_buffers.len() as u32;
750 for (gbo_pos, gbo_len) in global_buffers {
751 data.put_u64_le(gbo_pos);
752 data.put_u64_le(gbo_len);
753 }
754
755 let (major, minor) = version.to_numbers();
756
757 data.put_u64_le(col_metadata_start);
759 data.put_u64_le(cmo_table_start);
760 data.put_u64_le(gbo_table_start);
761 data.put_u32_le(num_global_buffers);
762 data.put_u32_le(batch.page_table.len() as u32);
763 data.put_u16_le(major as u16);
764 data.put_u16_le(minor as u16);
765 data.put(MAGIC.as_slice());
766
767 Ok(data.freeze())
768}
769
770impl EncodedBatchWriteExt for EncodedBatch {
771 fn try_to_self_described_lance(&self, version: LanceFileVersion) -> Result<Bytes> {
772 concat_lance_footer(self, true, version)
773 }
774
775 fn try_to_mini_lance(&self, version: LanceFileVersion) -> Result<Bytes> {
776 concat_lance_footer(self, false, version)
777 }
778}
779
780#[cfg(test)]
781mod tests {
782 use std::collections::HashMap;
783 use std::sync::Arc;
784
785 use crate::reader::{describe_encoding, FileReader, FileReaderOptions};
786 use crate::testing::FsFixture;
787 use crate::writer::{FileWriter, FileWriterOptions, ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES};
788 use arrow_array::builder::{Float32Builder, Int32Builder};
789 use arrow_array::{types::Float64Type, RecordBatchReader, StringArray};
790 use arrow_array::{Int32Array, RecordBatch, UInt64Array};
791 use arrow_schema::{DataType, Field, Field as ArrowField, Schema, Schema as ArrowSchema};
792 use lance_core::cache::LanceCache;
793 use lance_core::datatypes::Schema as LanceSchema;
794 use lance_core::utils::tempfile::TempObjFile;
795 use lance_datagen::{array, gen_batch, BatchCount, RowCount};
796 use lance_encoding::compression_config::{CompressionFieldParams, CompressionParams};
797 use lance_encoding::decoder::DecoderPlugins;
798 use lance_encoding::version::LanceFileVersion;
799 use lance_io::object_store::ObjectStore;
800 use lance_io::utils::CachedFileSize;
801
802 #[tokio::test]
803 async fn test_basic_write() {
804 let tmp_path = TempObjFile::default();
805 let obj_store = Arc::new(ObjectStore::local());
806
807 let reader = gen_batch()
808 .col("score", array::rand::<Float64Type>())
809 .into_reader_rows(RowCount::from(1000), BatchCount::from(10));
810
811 let writer = obj_store.create(&tmp_path).await.unwrap();
812
813 let lance_schema =
814 lance_core::datatypes::Schema::try_from(reader.schema().as_ref()).unwrap();
815
816 let mut file_writer =
817 FileWriter::try_new(writer, lance_schema, FileWriterOptions::default()).unwrap();
818
819 for batch in reader {
820 file_writer.write_batch(&batch.unwrap()).await.unwrap();
821 }
822 file_writer.add_schema_metadata("foo", "bar");
823 file_writer.finish().await.unwrap();
824 }
826
827 #[tokio::test]
828 async fn test_write_empty() {
829 let tmp_path = TempObjFile::default();
830 let obj_store = Arc::new(ObjectStore::local());
831
832 let reader = gen_batch()
833 .col("score", array::rand::<Float64Type>())
834 .into_reader_rows(RowCount::from(0), BatchCount::from(0));
835
836 let writer = obj_store.create(&tmp_path).await.unwrap();
837
838 let lance_schema =
839 lance_core::datatypes::Schema::try_from(reader.schema().as_ref()).unwrap();
840
841 let mut file_writer =
842 FileWriter::try_new(writer, lance_schema, FileWriterOptions::default()).unwrap();
843
844 for batch in reader {
845 file_writer.write_batch(&batch.unwrap()).await.unwrap();
846 }
847 file_writer.add_schema_metadata("foo", "bar");
848 file_writer.finish().await.unwrap();
849 }
850
851 #[tokio::test]
852 async fn test_max_page_bytes_enforced() {
853 let arrow_field = Field::new("data", DataType::UInt64, false);
854 let arrow_schema = Schema::new(vec![arrow_field]);
855 let lance_schema = LanceSchema::try_from(&arrow_schema).unwrap();
856
857 let data: Vec<u64> = (0..1_000_000).collect();
859 let array = UInt64Array::from(data);
860 let batch =
861 RecordBatch::try_new(arrow_schema.clone().into(), vec![Arc::new(array)]).unwrap();
862
863 let options = FileWriterOptions {
864 max_page_bytes: Some(1024 * 1024), format_version: Some(LanceFileVersion::V2_0),
867 ..Default::default()
868 };
869
870 let path = TempObjFile::default();
871 let object_store = ObjectStore::local();
872 let mut writer = FileWriter::try_new(
873 object_store.create(&path).await.unwrap(),
874 lance_schema,
875 options,
876 )
877 .unwrap();
878
879 writer.write_batch(&batch).await.unwrap();
880 writer.finish().await.unwrap();
881
882 let fs = FsFixture::default();
883 let file_scheduler = fs
884 .scheduler
885 .open_file(&path, &CachedFileSize::unknown())
886 .await
887 .unwrap();
888 let file_reader = FileReader::try_open(
889 file_scheduler,
890 None,
891 Arc::<DecoderPlugins>::default(),
892 &LanceCache::no_cache(),
893 FileReaderOptions::default(),
894 )
895 .await
896 .unwrap();
897
898 let column_meta = file_reader.metadata();
899
900 let mut total_page_num: u32 = 0;
901 for (col_idx, col_metadata) in column_meta.column_metadatas.iter().enumerate() {
902 assert!(
903 !col_metadata.pages.is_empty(),
904 "Column {} has no pages",
905 col_idx
906 );
907
908 for (page_idx, page) in col_metadata.pages.iter().enumerate() {
909 total_page_num += 1;
910 let total_size: u64 = page.buffer_sizes.iter().sum();
911 assert!(
912 total_size <= 1024 * 1024,
913 "Column {} Page {} size {} exceeds 1MB limit",
914 col_idx,
915 page_idx,
916 total_size
917 );
918 }
919 }
920
921 assert_eq!(total_page_num, 8)
922 }
923
924 #[tokio::test(flavor = "current_thread")]
925 async fn test_max_page_bytes_env_var() {
926 let arrow_field = Field::new("data", DataType::UInt64, false);
927 let arrow_schema = Schema::new(vec![arrow_field]);
928 let lance_schema = LanceSchema::try_from(&arrow_schema).unwrap();
929 let data: Vec<u64> = (0..500_000).collect();
931 let array = UInt64Array::from(data);
932 let batch =
933 RecordBatch::try_new(arrow_schema.clone().into(), vec![Arc::new(array)]).unwrap();
934
935 std::env::set_var(ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES, "2097152");
937
938 let options = FileWriterOptions {
939 max_page_bytes: None, ..Default::default()
941 };
942
943 let path = TempObjFile::default();
944 let object_store = ObjectStore::local();
945 let mut writer = FileWriter::try_new(
946 object_store.create(&path).await.unwrap(),
947 lance_schema.clone(),
948 options,
949 )
950 .unwrap();
951
952 writer.write_batch(&batch).await.unwrap();
953 writer.finish().await.unwrap();
954
955 let fs = FsFixture::default();
956 let file_scheduler = fs
957 .scheduler
958 .open_file(&path, &CachedFileSize::unknown())
959 .await
960 .unwrap();
961 let file_reader = FileReader::try_open(
962 file_scheduler,
963 None,
964 Arc::<DecoderPlugins>::default(),
965 &LanceCache::no_cache(),
966 FileReaderOptions::default(),
967 )
968 .await
969 .unwrap();
970
971 for col_metadata in file_reader.metadata().column_metadatas.iter() {
972 for page in col_metadata.pages.iter() {
973 let total_size: u64 = page.buffer_sizes.iter().sum();
974 assert!(
975 total_size <= 2 * 1024 * 1024,
976 "Page size {} exceeds 2MB limit",
977 total_size
978 );
979 }
980 }
981
982 std::env::set_var(ENV_LANCE_FILE_WRITER_MAX_PAGE_BYTES, "");
983 }
984
985 #[tokio::test]
986 async fn test_compression_overrides_end_to_end() {
987 let arrow_schema = Arc::new(ArrowSchema::new(vec![
989 ArrowField::new("customer_id", DataType::Int32, false),
990 ArrowField::new("product_id", DataType::Int32, false),
991 ArrowField::new("quantity", DataType::Int32, false),
992 ArrowField::new("price", DataType::Float32, false),
993 ArrowField::new("description", DataType::Utf8, false),
994 ]));
995
996 let lance_schema = LanceSchema::try_from(arrow_schema.as_ref()).unwrap();
997
998 let mut customer_ids = Int32Builder::new();
1000 let mut product_ids = Int32Builder::new();
1001 let mut quantities = Int32Builder::new();
1002 let mut prices = Float32Builder::new();
1003 let mut descriptions = Vec::new();
1004
1005 for i in 0..10000 {
1012 customer_ids.append_value(i / 100);
1015
1016 product_ids.append_value(i / 2000);
1018
1019 quantities.append_value(if i % 10 == 0 { 5 } else { 1 });
1021
1022 prices.append_value(match i % 3 {
1024 0 => 9.99,
1025 1 => 19.99,
1026 _ => 29.99,
1027 });
1028
1029 descriptions.push(format!("Product {}", i / 2000));
1031 }
1032
1033 let batch = RecordBatch::try_new(
1034 arrow_schema.clone(),
1035 vec![
1036 Arc::new(customer_ids.finish()),
1037 Arc::new(product_ids.finish()),
1038 Arc::new(quantities.finish()),
1039 Arc::new(prices.finish()),
1040 Arc::new(StringArray::from(descriptions)),
1041 ],
1042 )
1043 .unwrap();
1044
1045 let mut params = CompressionParams::new();
1047
1048 params.columns.insert(
1050 "*_id".to_string(),
1051 CompressionFieldParams {
1052 rle_threshold: Some(0.5), compression: None, compression_level: None,
1055 bss: Some(lance_encoding::compression_config::BssMode::Off), minichunk_size: None,
1057 },
1058 );
1059
1060 let encoding_strategy = lance_encoding::encoder::default_encoding_strategy_with_params(
1065 LanceFileVersion::V2_1,
1066 params,
1067 )
1068 .unwrap();
1069
1070 let options = FileWriterOptions {
1072 encoding_strategy: Some(Arc::from(encoding_strategy)),
1073 format_version: Some(LanceFileVersion::V2_1),
1074 max_page_bytes: Some(64 * 1024), ..Default::default()
1076 };
1077
1078 let path = TempObjFile::default();
1080 let object_store = ObjectStore::local();
1081
1082 let mut writer = FileWriter::try_new(
1083 object_store.create(&path).await.unwrap(),
1084 lance_schema.clone(),
1085 options,
1086 )
1087 .unwrap();
1088
1089 writer.write_batch(&batch).await.unwrap();
1090 writer.add_schema_metadata("compression_test", "configured_compression");
1091 writer.finish().await.unwrap();
1092
1093 let path_no_compression = TempObjFile::default();
1095 let default_options = FileWriterOptions {
1096 format_version: Some(LanceFileVersion::V2_1),
1097 max_page_bytes: Some(64 * 1024),
1098 ..Default::default()
1099 };
1100
1101 let mut writer_no_compression = FileWriter::try_new(
1102 object_store.create(&path_no_compression).await.unwrap(),
1103 lance_schema.clone(),
1104 default_options,
1105 )
1106 .unwrap();
1107
1108 writer_no_compression.write_batch(&batch).await.unwrap();
1109 writer_no_compression.finish().await.unwrap();
1110
1111 let fs = FsFixture::default();
1117 let file_scheduler = fs
1118 .scheduler
1119 .open_file(&path, &CachedFileSize::unknown())
1120 .await
1121 .unwrap();
1122
1123 let file_reader = FileReader::try_open(
1124 file_scheduler,
1125 None,
1126 Arc::<DecoderPlugins>::default(),
1127 &LanceCache::no_cache(),
1128 FileReaderOptions::default(),
1129 )
1130 .await
1131 .unwrap();
1132
1133 let metadata = file_reader.metadata();
1135 assert_eq!(metadata.major_version, 2);
1136 assert_eq!(metadata.minor_version, 1);
1137
1138 let schema = file_reader.schema();
1139 assert_eq!(
1140 schema.metadata.get("compression_test"),
1141 Some(&"configured_compression".to_string())
1142 );
1143
1144 let column_metadatas = &metadata.column_metadatas;
1146
1147 assert!(!column_metadatas[0].pages.is_empty());
1149 let customer_id_encoding = describe_encoding(&column_metadatas[0].pages[0]);
1150 assert!(
1151 customer_id_encoding.contains("RLE") || customer_id_encoding.contains("Rle"),
1152 "customer_id column should use RLE encoding due to '*_id' pattern match, but got: {}",
1153 customer_id_encoding
1154 );
1155
1156 assert!(!column_metadatas[1].pages.is_empty());
1158 let product_id_encoding = describe_encoding(&column_metadatas[1].pages[0]);
1159 assert!(
1160 product_id_encoding.contains("RLE") || product_id_encoding.contains("Rle"),
1161 "product_id column should use RLE encoding due to '*_id' pattern match, but got: {}",
1162 product_id_encoding
1163 );
1164 }
1165
1166 #[tokio::test]
1167 async fn test_field_metadata_compression() {
1168 let mut metadata = HashMap::new();
1170 metadata.insert(
1171 lance_encoding::constants::COMPRESSION_META_KEY.to_string(),
1172 "zstd".to_string(),
1173 );
1174 metadata.insert(
1175 lance_encoding::constants::COMPRESSION_LEVEL_META_KEY.to_string(),
1176 "6".to_string(),
1177 );
1178
1179 let arrow_schema = Arc::new(ArrowSchema::new(vec![
1180 ArrowField::new("id", DataType::Int32, false),
1181 ArrowField::new("text", DataType::Utf8, false).with_metadata(metadata.clone()),
1182 ArrowField::new("data", DataType::Int32, false).with_metadata(HashMap::from([(
1183 lance_encoding::constants::COMPRESSION_META_KEY.to_string(),
1184 "none".to_string(),
1185 )])),
1186 ]));
1187
1188 let lance_schema = LanceSchema::try_from(arrow_schema.as_ref()).unwrap();
1189
1190 let id_array = Int32Array::from_iter_values(0..1000);
1192 let text_array = StringArray::from_iter_values(
1193 (0..1000).map(|i| format!("test string {} repeated text", i)),
1194 );
1195 let data_array = Int32Array::from_iter_values((0..1000).map(|i| i * 2));
1196
1197 let batch = RecordBatch::try_new(
1198 arrow_schema.clone(),
1199 vec![
1200 Arc::new(id_array),
1201 Arc::new(text_array),
1202 Arc::new(data_array),
1203 ],
1204 )
1205 .unwrap();
1206
1207 let path = TempObjFile::default();
1208 let object_store = ObjectStore::local();
1209
1210 let params = CompressionParams::new();
1212 let encoding_strategy = lance_encoding::encoder::default_encoding_strategy_with_params(
1213 LanceFileVersion::V2_1,
1214 params,
1215 )
1216 .unwrap();
1217
1218 let options = FileWriterOptions {
1219 encoding_strategy: Some(Arc::from(encoding_strategy)),
1220 format_version: Some(LanceFileVersion::V2_1),
1221 ..Default::default()
1222 };
1223 let mut writer = FileWriter::try_new(
1224 object_store.create(&path).await.unwrap(),
1225 lance_schema.clone(),
1226 options,
1227 )
1228 .unwrap();
1229
1230 writer.write_batch(&batch).await.unwrap();
1231 writer.finish().await.unwrap();
1232
1233 let fs = FsFixture::default();
1235 let file_scheduler = fs
1236 .scheduler
1237 .open_file(&path, &CachedFileSize::unknown())
1238 .await
1239 .unwrap();
1240 let file_reader = FileReader::try_open(
1241 file_scheduler,
1242 None,
1243 Arc::<DecoderPlugins>::default(),
1244 &LanceCache::no_cache(),
1245 FileReaderOptions::default(),
1246 )
1247 .await
1248 .unwrap();
1249
1250 let column_metadatas = &file_reader.metadata().column_metadatas;
1251
1252 let text_encoding = describe_encoding(&column_metadatas[1].pages[0]);
1254 assert!(
1256 text_encoding.contains("Zstd"),
1257 "text column should use zstd compression from field metadata, but got: {}",
1258 text_encoding
1259 );
1260
1261 let data_encoding = describe_encoding(&column_metadatas[2].pages[0]);
1263 assert!(
1265 data_encoding.contains("Flat") && data_encoding.contains("compression: None"),
1266 "data column should use no compression from field metadata, but got: {}",
1267 data_encoding
1268 );
1269 }
1270
1271 #[tokio::test]
1272 async fn test_field_metadata_rle_threshold() {
1273 let mut metadata = HashMap::new();
1275 metadata.insert(
1276 lance_encoding::constants::RLE_THRESHOLD_META_KEY.to_string(),
1277 "0.9".to_string(),
1278 );
1279 metadata.insert(
1281 lance_encoding::constants::COMPRESSION_META_KEY.to_string(),
1282 "lz4".to_string(),
1283 );
1284 metadata.insert(
1286 lance_encoding::constants::BSS_META_KEY.to_string(),
1287 "off".to_string(),
1288 );
1289
1290 let arrow_schema = Arc::new(ArrowSchema::new(vec![ArrowField::new(
1291 "status",
1292 DataType::Int32,
1293 false,
1294 )
1295 .with_metadata(metadata)]));
1296
1297 let lance_schema = LanceSchema::try_from(arrow_schema.as_ref()).unwrap();
1298
1299 let status_array = Int32Array::from_iter_values(
1301 std::iter::repeat_n(200, 8000)
1302 .chain(std::iter::repeat_n(404, 1500))
1303 .chain(std::iter::repeat_n(500, 500)),
1304 );
1305
1306 let batch =
1307 RecordBatch::try_new(arrow_schema.clone(), vec![Arc::new(status_array)]).unwrap();
1308
1309 let path = TempObjFile::default();
1310 let object_store = ObjectStore::local();
1311
1312 let params = CompressionParams::new();
1314 let encoding_strategy = lance_encoding::encoder::default_encoding_strategy_with_params(
1315 LanceFileVersion::V2_1,
1316 params,
1317 )
1318 .unwrap();
1319
1320 let options = FileWriterOptions {
1321 encoding_strategy: Some(Arc::from(encoding_strategy)),
1322 format_version: Some(LanceFileVersion::V2_1),
1323 ..Default::default()
1324 };
1325 let mut writer = FileWriter::try_new(
1326 object_store.create(&path).await.unwrap(),
1327 lance_schema.clone(),
1328 options,
1329 )
1330 .unwrap();
1331
1332 writer.write_batch(&batch).await.unwrap();
1333 writer.finish().await.unwrap();
1334
1335 let fs = FsFixture::default();
1337 let file_scheduler = fs
1338 .scheduler
1339 .open_file(&path, &CachedFileSize::unknown())
1340 .await
1341 .unwrap();
1342 let file_reader = FileReader::try_open(
1343 file_scheduler,
1344 None,
1345 Arc::<DecoderPlugins>::default(),
1346 &LanceCache::no_cache(),
1347 FileReaderOptions::default(),
1348 )
1349 .await
1350 .unwrap();
1351
1352 let column_metadatas = &file_reader.metadata().column_metadatas;
1353 let status_encoding = describe_encoding(&column_metadatas[0].pages[0]);
1354 assert!(
1355 status_encoding.contains("RLE") || status_encoding.contains("Rle"),
1356 "status column should use RLE encoding due to metadata threshold, but got: {}",
1357 status_encoding
1358 );
1359 }
1360
1361 #[tokio::test]
1362 async fn test_large_page_split_on_read() {
1363 use arrow_array::Array;
1364 use futures::TryStreamExt;
1365 use lance_encoding::decoder::FilterExpression;
1366 use lance_io::ReadBatchParams;
1367
1368 let arrow_field = ArrowField::new("data", DataType::Binary, false);
1371 let arrow_schema = ArrowSchema::new(vec![arrow_field]);
1372 let lance_schema = LanceSchema::try_from(&arrow_schema).unwrap();
1373
1374 let large_value = vec![42u8; 40 * 1024 * 1024];
1376 let array = arrow_array::BinaryArray::from(vec![
1377 Some(large_value.as_slice()),
1378 Some(b"small value"),
1379 ]);
1380 let batch = RecordBatch::try_new(Arc::new(arrow_schema), vec![Arc::new(array)]).unwrap();
1381
1382 let options = FileWriterOptions {
1384 max_page_bytes: Some(128 * 1024 * 1024),
1385 format_version: Some(LanceFileVersion::V2_1),
1386 ..Default::default()
1387 };
1388
1389 let fs = FsFixture::default();
1390 let path = fs.tmp_path;
1391
1392 let mut writer = FileWriter::try_new(
1393 fs.object_store.create(&path).await.unwrap(),
1394 lance_schema.clone(),
1395 options,
1396 )
1397 .unwrap();
1398
1399 writer.write_batch(&batch).await.unwrap();
1400 let num_rows = writer.finish().await.unwrap();
1401 assert_eq!(num_rows, 2);
1402
1403 let file_scheduler = fs
1405 .scheduler
1406 .open_file(&path, &CachedFileSize::unknown())
1407 .await
1408 .unwrap();
1409
1410 let reader_options = FileReaderOptions {
1412 read_chunk_size: 10 * 1024 * 1024, ..Default::default()
1414 };
1415
1416 let file_reader = FileReader::try_open(
1417 file_scheduler,
1418 None,
1419 Arc::<DecoderPlugins>::default(),
1420 &LanceCache::no_cache(),
1421 reader_options,
1422 )
1423 .await
1424 .unwrap();
1425
1426 let stream = file_reader
1428 .read_stream(
1429 ReadBatchParams::RangeFull,
1430 1024,
1431 10, FilterExpression::no_filter(),
1433 )
1434 .unwrap();
1435
1436 let batches: Vec<RecordBatch> = stream.try_collect().await.unwrap();
1437 assert_eq!(batches.len(), 1);
1438
1439 let read_array = batches[0].column(0);
1441 let read_binary = read_array
1442 .as_any()
1443 .downcast_ref::<arrow_array::BinaryArray>()
1444 .unwrap();
1445
1446 assert_eq!(read_binary.len(), 2);
1447 assert_eq!(read_binary.value(0).len(), 40 * 1024 * 1024);
1448 assert_eq!(read_binary.value(1), b"small value");
1449
1450 assert!(read_binary.value(0).iter().all(|&b| b == 42u8));
1452 }
1453}