pylance

Contents

  • Lance Dataset
  • Basic IOs
  • Random Access
  • Data Evolution
  • Indexing and Searching
  • All Modules
    • BlobColumn
    • BlobFile
      • BlobFile.close()
      • BlobFile.closed
      • BlobFile.readable()
      • BlobFile.readall()
      • BlobFile.readinto()
      • BlobFile.seek()
      • BlobFile.seekable()
      • BlobFile.size()
      • BlobFile.tell()
    • DataStatistics
      • DataStatistics.fields
    • FFILanceTableProvider
    • FieldStatistics
      • FieldStatistics.bytes_on_disk
      • FieldStatistics.id
    • FragmentMetadata
      • FragmentMetadata.id
      • FragmentMetadata.files
      • FragmentMetadata.physical_rows
      • FragmentMetadata.deletion_file
      • FragmentMetadata.row_id_meta
      • FragmentMetadata.data_files()
      • FragmentMetadata.deletion_file
      • FragmentMetadata.files
      • FragmentMetadata.from_json()
      • FragmentMetadata.id
      • FragmentMetadata.num_deletions
      • FragmentMetadata.num_rows
      • FragmentMetadata.physical_rows
      • FragmentMetadata.row_id_meta
      • FragmentMetadata.to_json()
    • LanceDataset
      • LanceDataset.add_columns()
      • LanceDataset.alter_columns()
      • LanceDataset.checkout_version()
      • LanceDataset.cleanup_old_versions()
      • LanceDataset.commit()
      • LanceDataset.commit_batch()
      • LanceDataset.config()
      • LanceDataset.count_rows()
      • LanceDataset.create_index()
      • LanceDataset.create_scalar_index()
      • LanceDataset.data_storage_version
      • LanceDataset.delete()
      • LanceDataset.delete_config_keys()
      • LanceDataset.drop()
      • LanceDataset.drop_columns()
      • LanceDataset.drop_index()
      • LanceDataset.get_fragment()
      • LanceDataset.get_fragments()
      • LanceDataset.has_index
      • LanceDataset.head()
      • LanceDataset.index_statistics()
      • LanceDataset.insert()
      • LanceDataset.join()
      • LanceDataset.lance_schema
      • LanceDataset.latest_version
      • LanceDataset.list_indices()
      • LanceDataset.max_field_id
      • LanceDataset.merge()
      • LanceDataset.merge_insert()
      • LanceDataset.migrate_manifest_paths_v2()
      • LanceDataset.optimize
      • LanceDataset.partition_expression
      • LanceDataset.prewarm_index()
      • LanceDataset.replace_field_metadata()
      • LanceDataset.replace_schema()
      • LanceDataset.replace_schema_metadata()
      • LanceDataset.restore()
      • LanceDataset.sample()
      • LanceDataset.scanner()
      • LanceDataset.schema
      • LanceDataset.session()
      • LanceDataset.stats
      • LanceDataset.tags
      • LanceDataset.take()
      • LanceDataset.take_blobs()
      • LanceDataset.to_batches()
      • LanceDataset.to_table()
      • LanceDataset.update()
      • LanceDataset.update_config()
      • LanceDataset.uri
      • LanceDataset.validate()
      • LanceDataset.version
      • LanceDataset.versions()
    • LanceFragment
      • LanceFragment.count_rows()
      • LanceFragment.create()
      • LanceFragment.create_from_file()
      • LanceFragment.data_files()
      • LanceFragment.delete()
      • LanceFragment.deletion_file()
      • LanceFragment.fragment_id
      • LanceFragment.head()
      • LanceFragment.merge()
      • LanceFragment.merge_columns()
      • LanceFragment.metadata
      • LanceFragment.num_deletions
      • LanceFragment.partition_expression
      • LanceFragment.physical_rows
      • LanceFragment.physical_schema
      • LanceFragment.scanner()
      • LanceFragment.schema
      • LanceFragment.take()
      • LanceFragment.to_batches()
      • LanceFragment.to_table()
    • LanceOperation
      • LanceOperation.Append
        • LanceOperation.Append.fragments
        • LanceOperation.Append.fragments
      • LanceOperation.BaseOperation
      • LanceOperation.CreateIndex
        • LanceOperation.CreateIndex.created_at
        • LanceOperation.CreateIndex.dataset_version
        • LanceOperation.CreateIndex.fields
        • LanceOperation.CreateIndex.fragment_ids
        • LanceOperation.CreateIndex.index_version
        • LanceOperation.CreateIndex.name
        • LanceOperation.CreateIndex.uuid
      • LanceOperation.DataReplacement
        • LanceOperation.DataReplacement.replacements
      • LanceOperation.DataReplacementGroup
        • LanceOperation.DataReplacementGroup.fragment_id
        • LanceOperation.DataReplacementGroup.new_file
      • LanceOperation.Delete
        • LanceOperation.Delete.updated_fragments
        • LanceOperation.Delete.deleted_fragment_ids
        • LanceOperation.Delete.predicate
        • LanceOperation.Delete.deleted_fragment_ids
        • LanceOperation.Delete.predicate
        • LanceOperation.Delete.updated_fragments
      • LanceOperation.Merge
        • LanceOperation.Merge.fragments
        • LanceOperation.Merge.schema
        • LanceOperation.Merge.fragments
        • LanceOperation.Merge.schema
      • LanceOperation.Overwrite
        • LanceOperation.Overwrite.new_schema
        • LanceOperation.Overwrite.fragments
        • LanceOperation.Overwrite.fragments
        • LanceOperation.Overwrite.new_schema
      • LanceOperation.Project
        • LanceOperation.Project.schema
        • LanceOperation.Project.schema
      • LanceOperation.Restore
        • LanceOperation.Restore.version
      • LanceOperation.Rewrite
        • LanceOperation.Rewrite.groups
        • LanceOperation.Rewrite.rewritten_indices
        • LanceOperation.Rewrite.groups
        • LanceOperation.Rewrite.rewritten_indices
      • LanceOperation.RewriteGroup
        • LanceOperation.RewriteGroup.new_fragments
        • LanceOperation.RewriteGroup.old_fragments
      • LanceOperation.RewrittenIndex
        • LanceOperation.RewrittenIndex.new_id
        • LanceOperation.RewrittenIndex.old_id
      • LanceOperation.Update
        • LanceOperation.Update.removed_fragment_ids
        • LanceOperation.Update.updated_fragments
        • LanceOperation.Update.new_fragments
        • LanceOperation.Update.fields_modified
        • LanceOperation.Update.fields_modified
        • LanceOperation.Update.new_fragments
        • LanceOperation.Update.removed_fragment_ids
        • LanceOperation.Update.updated_fragments
    • LanceScanner
      • LanceScanner.analyze_plan()
      • LanceScanner.count_rows()
      • LanceScanner.dataset_schema
      • LanceScanner.explain_plan()
      • LanceScanner.from_batches()
      • LanceScanner.from_dataset()
      • LanceScanner.from_fragment()
      • LanceScanner.head()
      • LanceScanner.projected_schema
      • LanceScanner.scan_batches()
      • LanceScanner.take()
      • LanceScanner.to_batches()
      • LanceScanner.to_reader()
      • LanceScanner.to_table()
    • MergeInsertBuilder
      • MergeInsertBuilder.conflict_retries()
      • MergeInsertBuilder.execute()
      • MergeInsertBuilder.execute_uncommitted()
      • MergeInsertBuilder.retry_timeout()
      • MergeInsertBuilder.when_matched_update_all()
      • MergeInsertBuilder.when_not_matched_by_source_delete()
      • MergeInsertBuilder.when_not_matched_insert_all()
    • ScanStatistics
      • ScanStatistics.bytes_read
      • ScanStatistics.indices_loaded
      • ScanStatistics.iops
      • ScanStatistics.parts_loaded
    • Transaction
      • Transaction.blobs_op
      • Transaction.operation
      • Transaction.read_version
      • Transaction.uuid
    • batch_udf()
    • bytes_read_counter()
    • dataset()
    • iops_counter()
    • json_to_schema()
    • schema_to_json()
    • set_logger()
    • write_dataset()
    • AlterColumn
      • AlterColumn.data_type
      • AlterColumn.name
      • AlterColumn.nullable
      • AlterColumn.path
    • AutoCleanupConfig
      • AutoCleanupConfig.interval
      • AutoCleanupConfig.older_than_seconds
    • BulkCommitResult
      • BulkCommitResult.dataset
      • BulkCommitResult.merged
    • DataStatistics
      • DataStatistics.fields
    • DatasetOptimizer
      • DatasetOptimizer.compact_files()
      • DatasetOptimizer.disable_auto_cleanup()
      • DatasetOptimizer.enable_auto_cleanup()
      • DatasetOptimizer.optimize_indices()
    • DatasetStats
      • DatasetStats.num_deleted_rows
      • DatasetStats.num_fragments
      • DatasetStats.num_small_files
    • ExecuteResult
      • ExecuteResult.num_deleted_rows
      • ExecuteResult.num_inserted_rows
      • ExecuteResult.num_updated_rows
    • FieldStatistics
      • FieldStatistics.bytes_on_disk
      • FieldStatistics.id
    • Index
      • Index.fields
      • Index.fragment_ids
      • Index.name
      • Index.type
      • Index.uuid
      • Index.version
    • LanceDataset
      • LanceDataset.add_columns()
      • LanceDataset.alter_columns()
      • LanceDataset.checkout_version()
      • LanceDataset.cleanup_old_versions()
      • LanceDataset.commit()
      • LanceDataset.commit_batch()
      • LanceDataset.config()
      • LanceDataset.count_rows()
      • LanceDataset.create_index()
      • LanceDataset.create_scalar_index()
      • LanceDataset.data_storage_version
      • LanceDataset.delete()
      • LanceDataset.delete_config_keys()
      • LanceDataset.drop()
      • LanceDataset.drop_columns()
      • LanceDataset.drop_index()
      • LanceDataset.get_fragment()
      • LanceDataset.get_fragments()
      • LanceDataset.has_index
      • LanceDataset.head()
      • LanceDataset.index_statistics()
      • LanceDataset.insert()
      • LanceDataset.join()
      • LanceDataset.lance_schema
      • LanceDataset.latest_version
      • LanceDataset.list_indices()
      • LanceDataset.max_field_id
      • LanceDataset.merge()
      • LanceDataset.merge_insert()
      • LanceDataset.migrate_manifest_paths_v2()
      • LanceDataset.optimize
      • LanceDataset.partition_expression
      • LanceDataset.prewarm_index()
      • LanceDataset.replace_field_metadata()
      • LanceDataset.replace_schema()
      • LanceDataset.replace_schema_metadata()
      • LanceDataset.restore()
      • LanceDataset.sample()
      • LanceDataset.scanner()
      • LanceDataset.schema
      • LanceDataset.session()
      • LanceDataset.stats
      • LanceDataset.tags
      • LanceDataset.take()
      • LanceDataset.take_blobs()
      • LanceDataset.to_batches()
      • LanceDataset.to_table()
      • LanceDataset.update()
      • LanceDataset.update_config()
      • LanceDataset.uri
      • LanceDataset.validate()
      • LanceDataset.version
      • LanceDataset.versions()
    • LanceOperation
      • LanceOperation.Append
        • LanceOperation.Append.fragments
        • LanceOperation.Append.fragments
      • LanceOperation.BaseOperation
      • LanceOperation.CreateIndex
        • LanceOperation.CreateIndex.created_at
        • LanceOperation.CreateIndex.dataset_version
        • LanceOperation.CreateIndex.fields
        • LanceOperation.CreateIndex.fragment_ids
        • LanceOperation.CreateIndex.index_version
        • LanceOperation.CreateIndex.name
        • LanceOperation.CreateIndex.uuid
      • LanceOperation.DataReplacement
        • LanceOperation.DataReplacement.replacements
      • LanceOperation.DataReplacementGroup
        • LanceOperation.DataReplacementGroup.fragment_id
        • LanceOperation.DataReplacementGroup.new_file
      • LanceOperation.Delete
        • LanceOperation.Delete.updated_fragments
        • LanceOperation.Delete.deleted_fragment_ids
        • LanceOperation.Delete.predicate
        • LanceOperation.Delete.deleted_fragment_ids
        • LanceOperation.Delete.predicate
        • LanceOperation.Delete.updated_fragments
      • LanceOperation.Merge
        • LanceOperation.Merge.fragments
        • LanceOperation.Merge.schema
        • LanceOperation.Merge.fragments
        • LanceOperation.Merge.schema
      • LanceOperation.Overwrite
        • LanceOperation.Overwrite.new_schema
        • LanceOperation.Overwrite.fragments
        • LanceOperation.Overwrite.fragments
        • LanceOperation.Overwrite.new_schema
      • LanceOperation.Project
        • LanceOperation.Project.schema
        • LanceOperation.Project.schema
      • LanceOperation.Restore
        • LanceOperation.Restore.version
      • LanceOperation.Rewrite
        • LanceOperation.Rewrite.groups
        • LanceOperation.Rewrite.rewritten_indices
        • LanceOperation.Rewrite.groups
        • LanceOperation.Rewrite.rewritten_indices
      • LanceOperation.RewriteGroup
        • LanceOperation.RewriteGroup.new_fragments
        • LanceOperation.RewriteGroup.old_fragments
      • LanceOperation.RewrittenIndex
        • LanceOperation.RewrittenIndex.new_id
        • LanceOperation.RewrittenIndex.old_id
      • LanceOperation.Update
        • LanceOperation.Update.removed_fragment_ids
        • LanceOperation.Update.updated_fragments
        • LanceOperation.Update.new_fragments
        • LanceOperation.Update.fields_modified
        • LanceOperation.Update.fields_modified
        • LanceOperation.Update.new_fragments
        • LanceOperation.Update.removed_fragment_ids
        • LanceOperation.Update.updated_fragments
    • LanceScanner
      • LanceScanner.analyze_plan()
      • LanceScanner.count_rows()
      • LanceScanner.dataset_schema
      • LanceScanner.explain_plan()
      • LanceScanner.from_batches()
      • LanceScanner.from_dataset()
      • LanceScanner.from_fragment()
      • LanceScanner.head()
      • LanceScanner.projected_schema
      • LanceScanner.scan_batches()
      • LanceScanner.take()
      • LanceScanner.to_batches()
      • LanceScanner.to_reader()
      • LanceScanner.to_table()
    • LanceStats
      • LanceStats.data_stats()
      • LanceStats.dataset_stats()
      • LanceStats.index_stats()
    • MergeInsertBuilder
      • MergeInsertBuilder.conflict_retries()
      • MergeInsertBuilder.execute()
      • MergeInsertBuilder.execute_uncommitted()
      • MergeInsertBuilder.retry_timeout()
      • MergeInsertBuilder.when_matched_update_all()
      • MergeInsertBuilder.when_not_matched_by_source_delete()
      • MergeInsertBuilder.when_not_matched_insert_all()
    • ScannerBuilder
      • ScannerBuilder.apply_defaults()
      • ScannerBuilder.batch_readahead()
      • ScannerBuilder.batch_size()
      • ScannerBuilder.columns()
      • ScannerBuilder.fast_search()
      • ScannerBuilder.filter()
      • ScannerBuilder.fragment_readahead()
      • ScannerBuilder.full_text_search()
      • ScannerBuilder.include_deleted_rows()
      • ScannerBuilder.io_buffer_size()
      • ScannerBuilder.late_materialization()
      • ScannerBuilder.limit()
      • ScannerBuilder.nearest()
      • ScannerBuilder.offset()
      • ScannerBuilder.prefilter()
      • ScannerBuilder.scan_in_order()
      • ScannerBuilder.scan_stats_callback()
      • ScannerBuilder.strict_batch_size()
      • ScannerBuilder.to_scanner()
      • ScannerBuilder.use_scalar_index()
      • ScannerBuilder.use_stats()
      • ScannerBuilder.with_fragments()
      • ScannerBuilder.with_row_address()
      • ScannerBuilder.with_row_id()
    • Tag
      • Tag.manifest_size
      • Tag.version
    • Tags
      • Tags.create()
      • Tags.delete()
      • Tags.get_version()
      • Tags.list()
      • Tags.list_ordered()
      • Tags.update()
    • Transaction
      • Transaction.blobs_op
      • Transaction.operation
      • Transaction.read_version
      • Transaction.uuid
    • UpdateResult
      • UpdateResult.num_rows_updated
    • VectorIndexReader
      • VectorIndexReader.centroids()
      • VectorIndexReader.num_partitions()
      • VectorIndexReader.read_partition()
    • Version
      • Version.metadata
      • Version.timestamp
      • Version.version
    • write_dataset()
    • DataFile
      • DataFile.path
      • DataFile.fields
      • DataFile.column_indices
      • DataFile.file_major_version
      • DataFile.file_minor_version
      • DataFile.file_size_bytes
      • DataFile.column_indices
      • DataFile.field_ids()
      • DataFile.fields
      • DataFile.file_major_version
      • DataFile.file_minor_version
      • DataFile.file_size_bytes
      • DataFile.path
    • DeletionFile
      • DeletionFile.asdict()
      • DeletionFile.file_type
      • DeletionFile.from_json()
      • DeletionFile.id
      • DeletionFile.json()
      • DeletionFile.num_deleted_rows
      • DeletionFile.path()
      • DeletionFile.read_version
    • FragmentMetadata
      • FragmentMetadata.id
      • FragmentMetadata.files
      • FragmentMetadata.physical_rows
      • FragmentMetadata.deletion_file
      • FragmentMetadata.row_id_meta
      • FragmentMetadata.data_files()
      • FragmentMetadata.deletion_file
      • FragmentMetadata.files
      • FragmentMetadata.from_json()
      • FragmentMetadata.id
      • FragmentMetadata.num_deletions
      • FragmentMetadata.num_rows
      • FragmentMetadata.physical_rows
      • FragmentMetadata.row_id_meta
      • FragmentMetadata.to_json()
    • LanceFragment
      • LanceFragment.count_rows()
      • LanceFragment.create()
      • LanceFragment.create_from_file()
      • LanceFragment.data_files()
      • LanceFragment.delete()
      • LanceFragment.deletion_file()
      • LanceFragment.fragment_id
      • LanceFragment.head()
      • LanceFragment.merge()
      • LanceFragment.merge_columns()
      • LanceFragment.metadata
      • LanceFragment.num_deletions
      • LanceFragment.partition_expression
      • LanceFragment.physical_rows
      • LanceFragment.physical_schema
      • LanceFragment.scanner()
      • LanceFragment.schema
      • LanceFragment.take()
      • LanceFragment.to_batches()
      • LanceFragment.to_table()
    • RowIdMeta
      • RowIdMeta.asdict()
      • RowIdMeta.from_json()
      • RowIdMeta.json()
    • write_fragments()
pylance
  • pylance
  • View page source

pylance

Lance is a modern columnar data format for ML and LLMs. This is the auto-generated Python documentation for its Python SDK pylance. For more detailed quickstart and user guide, please visit the official Lance documentation website.

Contents

  • Lance Dataset
  • Basic IOs
  • Random Access
  • Data Evolution
  • Indexing and Searching
  • All Modules
    • BlobColumn
    • BlobFile
    • DataStatistics
    • FFILanceTableProvider
    • FieldStatistics
    • FragmentMetadata
    • LanceDataset
    • LanceFragment
    • LanceOperation
    • LanceScanner
    • MergeInsertBuilder
    • ScanStatistics
    • Transaction
    • batch_udf()
    • bytes_read_counter()
    • dataset()
    • iops_counter()
    • json_to_schema()
    • schema_to_json()
    • set_logger()
    • write_dataset()
    • AlterColumn
    • AutoCleanupConfig
    • BulkCommitResult
    • DataStatistics
    • DatasetOptimizer
    • DatasetStats
    • ExecuteResult
    • FieldStatistics
    • Index
    • LanceDataset
    • LanceOperation
    • LanceScanner
    • LanceStats
    • MergeInsertBuilder
    • ScannerBuilder
    • Tag
    • Tags
    • Transaction
    • UpdateResult
    • VectorIndexReader
    • Version
    • write_dataset()
    • DataFile
    • DeletionFile
    • FragmentMetadata
    • LanceFragment
    • RowIdMeta
    • write_fragments()
Next

© Copyright 2025, Lance Developer.

Built with Sphinx using a theme provided by Read the Docs.