Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); ARROW-17299: [C++][Python] Expose the Scanner kDefaultBatchReadahead and kDefaultFragmentReadahead parameters by marsupialtail · Pull Request #13799 · apache/arrow · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions cpp/src/arrow/dataset/scanner.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -826,15 +826,6 @@ Status ScannerBuilder::UseThreads(bool use_threads) {
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int fragment_readahead) {
if (fragment_readahead <= 0) {
return Status::Invalid("FragmentReadahead must be greater than 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::BatchSize(int64_t batch_size) {
if (batch_size <= 0) {
return Status::Invalid("BatchSize must be greater than 0, got ", batch_size);
Expand All@@ -843,6 +834,24 @@ Status ScannerBuilder::BatchSize(int64_t batch_size) {
return Status::OK();
}

Status ScannerBuilder::BatchReadahead(int32_t batch_readahead) {
if (batch_readahead < 0) {
Comment thread
westonpace marked this conversation as resolved.
return Status::Invalid("BatchReadahead must be greater than or equal 0, got ",
batch_readahead);
}
scan_options_->batch_readahead = batch_readahead;
return Status::OK();
}

Status ScannerBuilder::FragmentReadahead(int32_t fragment_readahead) {
if (fragment_readahead < 0) {
return Status::Invalid("FragmentReadahead must be greater than or equal 0, got ",
fragment_readahead);
}
scan_options_->fragment_readahead = fragment_readahead;
return Status::OK();
}

Status ScannerBuilder::Pool(MemoryPool* pool) {
scan_options_->pool = pool;
return Status::OK();
Expand Down
23 changes: 19 additions & 4 deletions cpp/src/arrow/dataset/scanner.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ struct ARROW_DS_EXPORT ScanOptions {
/// Maximum row count for scanned batches.
int64_t batch_size = kDefaultBatchSize;

/// How many batches to read ahead within a file
/// How many batches to read ahead within a fragment.
///
/// Set to 0 to disable batch readahead
///
Expand DownExpand Up@@ -373,9 +373,6 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// ThreadPool found in ScanOptions;
Status UseThreads(bool use_threads = true);

/// \brief Limit how many fragments the scanner will read at once
Status FragmentReadahead(int fragment_readahead);

/// \brief Set the maximum number of rows per RecordBatch.
///
/// \param[in] batch_size the maximum number of rows.
Expand All@@ -384,6 +381,24 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any RecordBatch.
Status BatchSize(int64_t batch_size);

/// \brief Set the number of batches to read ahead within a fragment.
///
/// \param[in] batch_readahead How many batches to read ahead within a fragment
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
Status BatchReadahead(int32_t batch_readahead);

/// \brief Set the number of fragments to read ahead
///
/// \param[in] fragment_readahead How many fragments to read ahead
/// \returns an error if this number is less than 0.
///
/// This option provides a control on the RAM vs I/O tradeoff.
Status FragmentReadahead(int32_t fragment_readahead);

/// \brief Set the pool from which materialized and scanned arrays will be allocated.
Status Pool(MemoryPool* pool);

Expand Down
37 changes: 33 additions & 4 deletions python/pyarrow/_dataset.pyx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2168,11 +2168,14 @@ cdef class TaggedRecordBatchIterator(_Weakrefable):


_DEFAULT_BATCH_SIZE = 2**17

_DEFAULT_BATCH_READAHEAD = 16
_DEFAULT_FRAGMENT_READAHEAD = 4

cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
bint use_threads=True, MemoryPool memory_pool=None,
FragmentScanOptions fragment_scan_options=None)\
except *:
Expand DownExpand Up@@ -2207,6 +2210,8 @@ cdef void _populate_builder(const shared_ptr[CScannerBuilder]& ptr,
)

check_status(builder.BatchSize(batch_size))
check_status(builder.BatchReadahead(batch_readahead))
check_status(builder.FragmentReadahead(fragment_readahead))
check_status(builder.UseThreads(use_threads))
if memory_pool:
check_status(builder.Pool(maybe_unbox_memory_pool(memory_pool)))
Expand DownExpand Up@@ -2254,6 +2259,12 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. Increasing this number
will increase RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
Comment thread
marsupialtail marked this conversation as resolved.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2291,6 +2302,8 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
int fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Dataset,
Expand DownExpand Up@@ -2328,6 +2341,13 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
fragment_readahead : int, default 4
The number of files to read ahead. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand All@@ -2354,7 +2374,8 @@ cdef class Scanner(_Weakrefable):

builder = make_shared[CScannerBuilder](dataset.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=fragment_readahead, use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand All@@ -2367,6 +2388,7 @@ cdef class Scanner(_Weakrefable):
MemoryPool memory_pool=None,
object columns=None, Expression filter=None,
int batch_size=_DEFAULT_BATCH_SIZE,
int batch_readahead=_DEFAULT_BATCH_READAHEAD,
FragmentScanOptions fragment_scan_options=None):
"""
Create Scanner from Fragment,
Expand DownExpand Up@@ -2406,6 +2428,10 @@ cdef class Scanner(_Weakrefable):
The maximum row count for scanned record batches. If scanned
record batches are overflowing memory then this method can be
called to reduce their size.
batch_readahead : int, default 16
The number of batches to read ahead in a file. This might not work
for all file formats. Increasing this number will increase
RAM usage but could also improve IO utilization.
use_threads : bool, default True
If enabled, then maximum parallelism will be used determined by
the number of available CPU cores.
Expand DownExpand Up@@ -2435,7 +2461,9 @@ cdef class Scanner(_Weakrefable):
builder = make_shared[CScannerBuilder](pyarrow_unwrap_schema(schema),
fragment.unwrap(), options)
_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=batch_readahead,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD,

I don't think we need to specify this kwarg if we're just going to specify the default.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is a Cython quirk. You have to specify all the arguments.

use_threads=use_threads,
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)

Expand DownExpand Up@@ -2508,7 +2536,8 @@ cdef class Scanner(_Weakrefable):
FutureWarning)

_populate_builder(builder, columns=columns, filter=filter,
batch_size=batch_size, use_threads=use_threads,
batch_size=batch_size, batch_readahead=_DEFAULT_BATCH_READAHEAD,
fragment_readahead=_DEFAULT_FRAGMENT_READAHEAD, use_threads=use_threads,
Comment thread
marsupialtail marked this conversation as resolved.
memory_pool=memory_pool,
fragment_scan_options=fragment_scan_options)
scanner = GetResultValue(builder.get().Finish())
Expand Down
2 changes: 2 additions & 0 deletions python/pyarrow/includes/libarrow_dataset.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,8 @@ cdef extern from "arrow/dataset/api.h" namespace "arrow::dataset" nogil:
CStatus UseThreads(c_bool use_threads)
CStatus Pool(CMemoryPool* pool)
CStatus BatchSize(int64_t batch_size)
CStatus BatchReadahead(int32_t batch_readahead)
CStatus FragmentReadahead(int32_t fragment_readahead)
CStatus FragmentScanOptions(
shared_ptr[CFragmentScanOptions] fragment_scan_options)
CResult[shared_ptr[CScanner]] Finish()
Expand Down
7 changes: 7 additions & 0 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -423,6 +423,13 @@ def test_dataset(dataset, dataset_reader):
False, False, True, True]


@pytest.mark.parquet
def test_scanner_options(dataset):
scanner = dataset.to_batches(fragment_readahead=16, batch_readahead=8)
batch = next(scanner)
assert batch.num_columns == 7


@pytest.mark.parquet
def test_scanner(dataset, dataset_reader):
scanner = dataset_reader.scanner(
Expand Down