Skip to content

Commit

Permalink
add params to ScannerBuilder
Browse files Browse the repository at this point in the history
  • Loading branch information
jorisvandenbossche committed Dec 18, 2019
1 parent d816647 commit fb51e29
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion python/pyarrow/_dataset.pyx
Expand Up @@ -709,6 +709,14 @@ cdef class ScannerBuilder:
It is used to pass information, notably a potential filter expression and a
subset of columns to materialize.
Parameters
----------
dataset : Dataset
The dataset to scan.
memory_pool : MemoryPool, default None
For memory allocations, if required. If not specified, uses the
default pool.
"""

cdef:
Expand Down Expand Up @@ -767,7 +775,7 @@ cdef class ScannerBuilder:
Returns
-------
self : ScannerBuilder
Scanner
"""
return Scanner.wrap(GetResultValue(self.builder.Finish()))

Expand Down Expand Up @@ -820,6 +828,8 @@ cdef class ScannerBuilder:
cdef class Scanner:
"""A materialized scan operation with context and options bound.
Create this using the ScannerBuilder factory class.
A scanner is the class that glues the scan tasks, data fragments and data
sources together.
"""
Expand Down

0 comments on commit fb51e29

Please sign in to comment.