Class: Polars::IO::ScanOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/polars/io/scan_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(row_index: nil, pre_slice: nil, cast_options: nil, extra_columns: "raise", missing_columns: "raise", include_file_paths: nil, glob: true, hive_partitioning: nil, hive_schema: nil, try_parse_hive_dates: true, rechunk: false, cache: true, storage_options: nil, credential_provider: nil, retries: 2, column_mapping: nil, deletion_files: nil) ⇒ ScanOptions

Returns a new instance of ScanOptions.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/polars/io/scan_options.rb', line 8

def initialize(
  row_index: nil,
  pre_slice: nil,
  cast_options: nil,
  extra_columns: "raise",
  missing_columns: "raise",
  include_file_paths: nil,
  glob: true,
  hive_partitioning: nil,
  hive_schema: nil,
  try_parse_hive_dates: true,
  rechunk: false,
  cache: true,
  storage_options: nil,
  credential_provider: nil,
  retries: 2,
  column_mapping: nil,
  deletion_files: nil
)
  @row_index = row_index
  @pre_slice = pre_slice
  @cast_options = cast_options
  @extra_columns = extra_columns
  @missing_columns = missing_columns
  @include_file_paths = include_file_paths
  @glob = glob
  @hive_partitioning = hive_partitioning
  @hive_schema = hive_schema
  @try_parse_hive_dates = try_parse_hive_dates
  @rechunk = rechunk
  @cache = cache
  @storage_options = storage_options
  @credential_provider = credential_provider
  @retries = retries
  @column_mapping = column_mapping
  @deletion_files = deletion_files
end

Instance Attribute Details

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def cache
  @cache
end

#cast_options ⇒ Object (readonly)

Returns the value of attribute cast_options.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def cast_options
  @cast_options
end

#column_mapping ⇒ Object (readonly)

Returns the value of attribute column_mapping.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def column_mapping
  @column_mapping
end

#credential_provider ⇒ Object (readonly)

Returns the value of attribute credential_provider.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def credential_provider
  @credential_provider
end

#deletion_files ⇒ Object (readonly)

Returns the value of attribute deletion_files.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def deletion_files
  @deletion_files
end

#extra_columns ⇒ Object (readonly)

Returns the value of attribute extra_columns.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def extra_columns
  @extra_columns
end

#glob ⇒ Object (readonly)

Returns the value of attribute glob.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def glob
  @glob
end

#hive_partitioning ⇒ Object (readonly)

Returns the value of attribute hive_partitioning.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def hive_partitioning
  @hive_partitioning
end

#hive_schema ⇒ Object (readonly)

Returns the value of attribute hive_schema.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def hive_schema
  @hive_schema
end

#include_file_paths ⇒ Object (readonly)

Returns the value of attribute include_file_paths.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def include_file_paths
  @include_file_paths
end

#missing_columns ⇒ Object (readonly)

Returns the value of attribute missing_columns.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def missing_columns
  @missing_columns
end

#pre_slice ⇒ Object (readonly)

Returns the value of attribute pre_slice.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def pre_slice
  @pre_slice
end

#rechunk ⇒ Object (readonly)

Returns the value of attribute rechunk.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def rechunk
  @rechunk
end

#retries ⇒ Object (readonly)

Returns the value of attribute retries.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def retries
  @retries
end

#row_index ⇒ Object (readonly)

Returns the value of attribute row_index.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def row_index
  @row_index
end

#storage_options ⇒ Object (readonly)

Returns the value of attribute storage_options.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def storage_options
  @storage_options
end

#try_parse_hive_dates ⇒ Object (readonly)

Returns the value of attribute try_parse_hive_dates.



4
5
6
 
# File 'lib/polars/io/scan_options.rb', line 4

def try_parse_hive_dates
  @try_parse_hive_dates
end