blob: 58b9cf6a595bdb88ea8cecb9e97669e95e540a74 [file] [log] [blame]
{"meta":{"ns":"ArrowDataset","version":"1.0","generator":"gi-docgen","generator-version":"2022.1"},"symbols":[{"type":"class","name":"CSVFileFormat","ctype":"GADatasetCSVFileFormat","summary":"No description available."},{"type":"class","name":"Dataset","ctype":"GADatasetDataset","summary":"No description available."},{"type":"class","name":"DatasetFactory","ctype":"GADatasetDatasetFactory","summary":"No description available."},{"type":"class","name":"DirectoryPartitioning","ctype":"GADatasetDirectoryPartitioning","summary":"No description available."},{"type":"class","name":"FileFormat","ctype":"GADatasetFileFormat","summary":"No description available."},{"type":"class","name":"FileSystemDataset","ctype":"GADatasetFileSystemDataset","summary":"No description available."},{"type":"class","name":"FileSystemDatasetFactory","ctype":"GADatasetFileSystemDatasetFactory","summary":"No description available."},{"type":"class","name":"FileSystemDatasetWriteOptions","ctype":"GADatasetFileSystemDatasetWriteOptions","summary":"No description available."},{"type":"class","name":"FileWriteOptions","ctype":"GADatasetFileWriteOptions","summary":"No description available."},{"type":"class","name":"FileWriter","ctype":"GADatasetFileWriter","summary":"No description available."},{"type":"class","name":"FinishOptions","ctype":"GADatasetFinishOptions","summary":"No description available."},{"type":"class","name":"Fragment","ctype":"GADatasetFragment","summary":"No description available."},{"type":"class","name":"HivePartitioning","ctype":"GADatasetHivePartitioning","summary":"No description available."},{"type":"class","name":"HivePartitioningOptions","ctype":"GADatasetHivePartitioningOptions","summary":"No description available."},{"type":"class","name":"IPCFileFormat","ctype":"GADatasetIPCFileFormat","summary":"No description available."},{"type":"class","name":"InMemoryFragment","ctype":"GADatasetInMemoryFragment","summary":"No description available."},{"type":"class","name":"KeyValuePartitioning","ctype":"GADatasetKeyValuePartitioning","summary":"No description available."},{"type":"class","name":"KeyValuePartitioningOptions","ctype":"GADatasetKeyValuePartitioningOptions","summary":"No description available."},{"type":"class","name":"ParquetFileFormat","ctype":"GADatasetParquetFileFormat","summary":"No description available."},{"type":"class","name":"Partitioning","ctype":"GADatasetPartitioning","summary":"No description available."},{"type":"class","name":"PartitioningFactoryOptions","ctype":"GADatasetPartitioningFactoryOptions","summary":"No description available."},{"type":"class","name":"Scanner","ctype":"GADatasetScanner","summary":"No description available."},{"type":"class","name":"ScannerBuilder","ctype":"GADatasetScannerBuilder","summary":"No description available."},{"type":"ctor","name":"new","type_name":"CSVFileFormat","ident":"gadataset_csv_file_format_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"DirectoryPartitioning","ident":"gadataset_directory_partitioning_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"FileSystemDatasetFactory","ident":"gadataset_file_system_dataset_factory_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"FileSystemDatasetWriteOptions","ident":"gadataset_file_system_dataset_write_options_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"FinishOptions","ident":"gadataset_finish_options_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"HivePartitioning","ident":"gadataset_hive_partitioning_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"HivePartitioningOptions","ident":"gadataset_hive_partitioning_options_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"InMemoryFragment","ident":"gadataset_in_memory_fragment_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"IPCFileFormat","ident":"gadataset_ipc_file_format_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"KeyValuePartitioningOptions","ident":"gadataset_key_value_partitioning_options_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"ParquetFileFormat","ident":"gadataset_parquet_file_format_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"PartitioningFactoryOptions","ident":"gadataset_partitioning_factory_options_new","summary":"No description available."},{"type":"ctor","name":"new","type_name":"ScannerBuilder","ident":"gadataset_scanner_builder_new","summary":"No description available."},{"type":"ctor","name":"new_record_batch_reader","type_name":"ScannerBuilder","ident":"gadataset_scanner_builder_new_record_batch_reader","summary":"No description available."},{"type":"enum","name":"SegmentEncoding","ctype":"GADatasetSegmentEncoding","summary":"They are corresponding to `arrow::dataset::SegmentEncoding` values."},{"type":"method","name":"add_path","type_name":"FileSystemDatasetFactory","ident":"gadataset_file_system_dataset_factory_add_path","summary":"No description available."},{"type":"method","name":"begin_scan","type_name":"Dataset","ident":"gadataset_dataset_begin_scan","summary":"No description available."},{"type":"method","name":"equal","type_name":"FileFormat","ident":"gadataset_file_format_equal","summary":"No description available."},{"type":"method","name":"finish","type_name":"DatasetFactory","ident":"gadataset_dataset_factory_finish","summary":"No description available."},{"type":"method","name":"finish","type_name":"FileSystemDatasetFactory","ident":"gadataset_file_system_dataset_factory_finish","summary":"No description available."},{"type":"method","name":"finish","type_name":"FileWriter","ident":"gadataset_file_writer_finish","summary":"No description available."},{"type":"method","name":"finish","type_name":"ScannerBuilder","ident":"gadataset_scanner_builder_finish","summary":"No description available."},{"type":"method","name":"get_default_write_options","type_name":"FileFormat","ident":"gadataset_file_format_get_default_write_options","summary":"No description available."},{"type":"method","name":"get_null_fallback","type_name":"HivePartitioning","ident":"gadataset_hive_partitioning_get_null_fallback","summary":"No description available."},{"type":"method","name":"get_type_name","type_name":"Dataset","ident":"gadataset_dataset_get_type_name","summary":"No description available."},{"type":"method","name":"get_type_name","type_name":"FileFormat","ident":"gadataset_file_format_get_type_name","summary":"No description available."},{"type":"method","name":"get_type_name","type_name":"Partitioning","ident":"gadataset_partitioning_get_type_name","summary":"No description available."},{"type":"method","name":"open_writer","type_name":"FileFormat","ident":"gadataset_file_format_open_writer","summary":"No description available."},{"type":"method","name":"set_file_system","type_name":"FileSystemDatasetFactory","ident":"gadataset_file_system_dataset_factory_set_file_system","summary":"No description available."},{"type":"method","name":"set_file_system_uri","type_name":"FileSystemDatasetFactory","ident":"gadataset_file_system_dataset_factory_set_file_system_uri","summary":"No description available."},{"type":"method","name":"set_filter","type_name":"ScannerBuilder","ident":"gadataset_scanner_builder_set_filter","summary":"No description available."},{"type":"method","name":"to_table","type_name":"Dataset","ident":"gadataset_dataset_to_table","summary":"No description available."},{"type":"method","name":"to_table","type_name":"Scanner","ident":"gadataset_scanner_to_table","summary":"No description available."},{"type":"method","name":"write_record_batch","type_name":"FileWriter","ident":"gadataset_file_writer_write_record_batch","summary":"No description available."},{"type":"method","name":"write_record_batch_reader","type_name":"FileWriter","ident":"gadataset_file_writer_write_record_batch_reader","summary":"No description available."},{"type":"property","name":"base-dir","type_name":"FileSystemDatasetWriteOptions","summary":"No description available."},{"type":"property","name":"base-name-template","type_name":"FileSystemDatasetWriteOptions","summary":"Template string used to generate fragment base names. {i} ..."},{"type":"property","name":"dataset","type_name":"Dataset","summary":"No description available."},{"type":"property","name":"dataset-factory","type_name":"DatasetFactory","summary":"No description available."},{"type":"property","name":"file-system","type_name":"FileSystemDataset","summary":"File system of the dataset."},{"type":"property","name":"file-system","type_name":"FileSystemDatasetFactory","summary":"File system passed to #GADatasetFileSystemDataset."},{"type":"property","name":"file-system","type_name":"FileSystemDatasetWriteOptions","summary":"No description available."},{"type":"property","name":"file-write-options","type_name":"FileSystemDatasetWriteOptions","summary":"No description available."},{"type":"property","name":"finish-options","type_name":"FinishOptions","summary":"No description available."},{"type":"property","name":"format","type_name":"FileFormat","summary":"No description available."},{"type":"property","name":"format","type_name":"FileSystemDataset","summary":"Format of the dataset."},{"type":"property","name":"format","type_name":"FileSystemDatasetFactory","summary":"Format passed to #GADatasetFileSystemDataset."},{"type":"property","name":"fragment","type_name":"Fragment","summary":"No description available."},{"type":"property","name":"infer-dictionary","type_name":"PartitioningFactoryOptions","summary":"When inferring a schema for partition fields, yield dictionary ..."},{"type":"property","name":"inspect-n-fragments","type_name":"FinishOptions","summary":"The number of fragments to be used to inspect schema."},{"type":"property","name":"max-partitions","type_name":"FileSystemDatasetWriteOptions","summary":"Maximum number of partitions any batch may be written into."},{"type":"property","name":"null-fallback","type_name":"HivePartitioningOptions","summary":"The fallback string for null. This is used only ..."},{"type":"property","name":"options","type_name":"FileWriteOptions","summary":"No description available."},{"type":"property","name":"partition-base-dir","type_name":"FileSystemDatasetFactory","summary":"Partition base directory used by #GADatasetFileSystemDataset."},{"type":"property","name":"partitioning","type_name":"FileSystemDataset","summary":"Partitioning of the dataset."},{"type":"property","name":"partitioning","type_name":"FileSystemDatasetFactory","summary":"Partitioning used by #GADatasetFileSystemDataset."},{"type":"property","name":"partitioning","type_name":"FileSystemDatasetWriteOptions","summary":"#GADatasetPartitioning used to generate fragment paths."},{"type":"property","name":"partitioning","type_name":"Partitioning","summary":"No description available."},{"type":"property","name":"scanner","type_name":"Scanner","summary":"No description available."},{"type":"property","name":"scanner-builder","type_name":"ScannerBuilder","summary":"No description available."},{"type":"property","name":"schema","type_name":"FinishOptions","summary":"The schema to finalize the dataset's schema."},{"type":"property","name":"schema","type_name":"PartitioningFactoryOptions","summary":"Optionally, an expected schema can be provided, in which ..."},{"type":"property","name":"segment-encoding","type_name":"KeyValuePartitioningOptions","summary":"After splitting a path into components, decode the path ..."},{"type":"property","name":"segment-encoding","type_name":"PartitioningFactoryOptions","summary":"After splitting a path into components, decode the path ..."},{"type":"property","name":"validate-fragments","type_name":"FinishOptions","summary":"Whether validate fragments against the given schema or not."},{"type":"property","name":"writer","type_name":"FileWriter","summary":"No description available."},{"type":"type_func","name":"create_default","type_name":"Partitioning","ident":"gadataset_partitioning_create_default","summary":"No description available."},{"type":"type_func","name":"write_scanner","type_name":"FileSystemDataset","ident":"gadataset_file_system_dataset_write_scanner","summary":"No description available."}],"terms":{"`arrow::dataset::segmentencod":[90],"accord":[69,80],"add":[25],"after":[69,80],"against":[53,79],"all":[78],"an":[36,79],"ani":[39],"auto":[36],"avail":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,23,24,25,26,27,28,33,34,35,37,38,41,42,43,44,45,46,47,48,49,50,54,55,56,57,58,59,60,62,63,64,65,66,67,68,70,71,72,73,74,75,76,77,81,82,83,84,85,86,87,88,89],"base":[31,35,36],"batch":[39,45,46,86],"befor":[69,80],"begin":[3],"builder":[84,89],"can":[78,79],"case":[79],"check":[79],"column":[78],"compon":[69,80],"correspond":[90],"creat":[74],"csv":[0],"dataset":[2,6,7,9,18,20,21,22,23,33],"dataset'":[52],"decod":[69,80],"default":[14,74],"descript":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,23,24,25,26,27,28,33,34,35,37,38,41,42,43,44,45,46,47,48,49,50,54,55,56,57,58,59,60,62,63,64,65,66,67,68,70,71,72,73,74,75,76,77,81,82,83,84,85,86,87,88,89],"dictionari":[78,79],"dir":[31,35],"directori":[10,31],"discov":[79],"each":[78],"effici":[78],"encod":[69,78,80,90],"equal":[13],"expect":[79],"express":[78],"factori":[7,9,23,76],"fallback":[58,61],"field":[78,79],"file":[0,12,18,20,23,27,28,29,33,37,38,41,43,64,70],"filter":[88],"final":[52],"finish":[8,26,44,48,50,78,87],"format":[0,12,17,21,30,64,70],"fragment":[36,40,51,53,54,55,62],"gadataset_csv_file_format_new":[1],"gadataset_dataset_begin_scan":[3],"gadataset_dataset_factory_finish":[8],"gadataset_dataset_get_type_name":[4],"gadataset_dataset_to_table":[5],"gadataset_directory_partitioning_new":[11],"gadataset_file_format_equal":[13],"gadataset_file_format_get_default_write_options":[14],"gadataset_file_format_get_type_name":[15],"gadataset_file_format_open_writer":[16],"gadataset_file_system_dataset_factory_add_path":[25],"gadataset_file_system_dataset_factory_finish":[26],"gadataset_file_system_dataset_factory_new":[24],"gadataset_file_system_dataset_factory_set_file_system":[27],"gadataset_file_system_dataset_factory_set_file_system_uri":[28],"gadataset_file_system_dataset_write_options_new":[34],"gadataset_file_system_dataset_write_scanner":[19],"gadataset_file_writer_finish":[44],"gadataset_file_writer_write_record_batch":[45],"gadataset_file_writer_write_record_batch_reader":[46],"gadataset_finish_options_new":[49],"gadataset_hive_partitioning_get_null_fallback":[58],"gadataset_hive_partitioning_new":[57],"gadataset_hive_partitioning_options_new":[60],"gadataset_in_memory_fragment_new":[63],"gadataset_ipc_file_format_new":[65],"gadataset_key_value_partitioning_options_new":[68],"gadataset_parquet_file_format_new":[71],"gadataset_partitioning_create_default":[74],"gadataset_partitioning_factory_options_new":[77],"gadataset_partitioning_get_type_name":[73],"gadataset_scanner_builder_finish":[87],"gadataset_scanner_builder_new":[85],"gadataset_scanner_builder_new_record_batch_reader":[86],"gadataset_scanner_builder_set_filter":[88],"gadataset_scanner_to_table":[82],"gadatasetcsvfileformat":[0],"gadatasetdataset":[2],"gadatasetdatasetfactory":[7],"gadatasetdirectorypartitioning":[10],"gadatasetfileformat":[12],"gadatasetfilesystemdataset":[18],"gadatasetfilesystemdatasetfactory":[23],"gadatasetfilesystemdatasetwriteoptions":[33],"gadatasetfilewriteoptions":[41],"gadatasetfilewriter":[43],"gadatasetfinishoptions":[48],"gadatasetfragment":[54],"gadatasethivepartitioning":[56],"gadatasethivepartitioningoptions":[59],"gadatasetinmemoryfragment":[62],"gadatasetipcfileformat":[64],"gadatasetkeyvaluepartitioning":[66],"gadatasetkeyvaluepartitioningoptions":[67],"gadatasetparquetfileformat":[70],"gadatasetpartitioning":[72],"gadatasetpartitioningfactoryoptions":[76],"gadatasetscanner":[81],"gadatasetscannerbuilder":[84],"gadatasetsegmentencoding":[90],"gener":[36,40],"get":[4,14,15,58,73],"given":[53],"hive":[56,59],"includ":[78],"increment":[36],"infer":[78,79],"inspect":[51,78],"instead":[78],"integ":[36],"intern":[79],"into":[39],"ipc":[64],"kei":[66,67],"mai":[39],"materi":[78],"max":[39],"maximum":[39],"memori":[62],"more":[78],"n":[51],"name":[4,15,36,73],"new":[1,11,24,34,49,57,60,63,65,68,71,77,85,86],"none":[90],"not":[53],"null":[58,61],"number":[39,51],"onli":[61,79],"open":[16],"option":[14,33,38,41,42,48,50,59,67,76,79],"parquet":[70],"pars":[69,78,80],"partit":[10,22,31,32,39,40,56,59,66,67,72,75,76,78],"pass":[29,30],"path":[25,40,69,80],"plain":[78],"provid":[79],"reader":[46,86],"record":[45,46,86],"replac":[36],"scan":[3],"scanner":[19,81,83,84,89],"schema":[51,52,53,78,79],"scheme":[69,80],"segment":[69,80,90],"set":[27,28,88],"split":[69,80],"state":[79],"string":[36,61],"such":[79],"system":[18,20,23,27,28,29,33,37],"tabl":[5,82],"templat":[36],"type":[4,15,73,78],"uniqu":[78],"updat":[79],"uri":[28,90],"url-encod":[90],"us":[31,32,36,40,51,61],"valid":[53],"valu":[66,67,78,90],"virtual":[78],"when":[78],"whether":[53],"which":[79],"write":[14,19,33,38,41,45,46],"writer":[16,43,47],"written":[39],"yield":[78],"{i}":[36]}}